TIBCO Streaming Web OpenAPI Specification

Authentication

login

Establish a session with the artifact server

The login operation uses either Basic or Bearer authentication. Basic authentication is only used in development outside of Kubernetes. It is not supported as a public product feature. In both cases the `Authorization` header must be included in the request with one of these two formats: Authorization: Basic ZGVtbzpwQDU1dzByZA== Authorization: Bearer <jwt-token-from-ingress> After successful credential validation, an API token is returned in a header named `X-Streaming-Web-API-Token`. The valid API token value must be provided in a `X-Streaming-Web-API-Token` HTTP header to all other operations. X-Streaming-Web-API-Token: <token> The API token expires after a configurable amount of time. When a API token expires, login must be repeated to get a new API token. Once an API token is obtained, subsequent API requests need only the `X-Streaming-Web-API-Token` HTTP header for authentication to the server. However, when an API request targets a server running in Kubernetes thru the ingress, the request must also have the JWT bearer token in the Authorization header. Sessions are automatically subscribed to receive all possible event notifications. This can be changed using the /notifications API.


/login

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/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];

// Establish a session with the artifact server
[apiInstance loginWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'


var api = new TibcoStreamingWebOpenApiSpecification.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
            {
                // Establish a session with the artifact server
                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: 
    # Establish a session with the artifact server
    api_instance.login()
except ApiException as e:
    print("Exception when calling AuthenticationApi->login: %s\n" % e)

Parameters

Responses

Status: 200 - Login was successful

Name Type Format Description
X-Streaming-Web-API-Token String
Authorization String

Status: 401 - Authentication information is missing or invalid

Status: 500 - Internal server error, contact support


logout

Terminate a session

The API token is invalid after this operation completes. The login operation must be executed to get a new valid API token.


/logout

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/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();

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


        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];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];

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

// Terminate a session
[apiInstance logoutWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


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

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

            var apiInstance = new AuthenticationApi();

            try
            {
                // Terminate a session
                apiInstance.logout();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

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

# Configure API key authorization: ApiTokenKey
swagger_client.configuration.api_key['X-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

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

try: 
    # Terminate a session
    api_instance.logout()
except ApiException as e:
    print("Exception when calling AuthenticationApi->logout: %s\n" % e)

Parameters

Responses

Status: 200 - Logout was successful

Status: 303 - Logout was successful, redirect to OAuth2 provider to complete logout processing

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 500 - Internal server error, contact support


Channel

bindChannel

Bind a schema to a data channel

Bind a schema to a data channel. The schema is bound as either an input or output schema based on the the data channel type, i.e. sink or source. The data channel with the bound item(s) is returned from this call on success.


/channels/{sandbox}/{project}/{channel}/bind

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/channels/{sandbox}/{project}/{channel}/bind"
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();

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


        ChannelApi apiInstance = new ChannelApi();
        BindChannelRequest body = ; // BindChannelRequest | schema and connection to bind to data channel
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        DataChannelReference channel = ; // DataChannelReference | data channel configuration path encoded as path param of form 'path=\,category=\'
        try {
            DataChannel result = apiInstance.bindChannel(body, sandbox, project, channel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChannelApi#bindChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChannelApi;

public class ChannelApiExample {

    public static void main(String[] args) {
        ChannelApi apiInstance = new ChannelApi();
        BindChannelRequest body = ; // BindChannelRequest | schema and connection to bind to data channel
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        DataChannelReference channel = ; // DataChannelReference | data channel configuration path encoded as path param of form 'path=\,category=\'
        try {
            DataChannel result = apiInstance.bindChannel(body, sandbox, project, channel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChannelApi#bindChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
BindChannelRequest *body = ; // schema and connection to bind to data channel
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
DataChannelReference *channel = ; // data channel configuration path encoded as path param of form 'path=\,category=\'

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

// Bind a schema to a data channel
[apiInstance bindChannelWith:body
    sandbox:sandbox
    project:project
    channel:channel
              completionHandler: ^(DataChannel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ChannelApi()
var body = ; // {{BindChannelRequest}} schema and connection to bind to data channel
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var channel = ; // {{DataChannelReference}} data channel configuration path encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new ChannelApi();
            var body = new BindChannelRequest(); // BindChannelRequest | schema and connection to bind to data channel
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var channel = new DataChannelReference(); // DataChannelReference | data channel configuration path encoded as path param of form 'path=\,category=\'

            try
            {
                // Bind a schema to a data channel
                DataChannel result = apiInstance.bindChannel(body, sandbox, project, channel);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelApi.bindChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiChannelApi();
$body = ; // BindChannelRequest | schema and connection to bind to data channel
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$channel = ; // DataChannelReference | data channel configuration path encoded as path param of form 'path=\,category=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChannelApi->new();
my $body = WWW::SwaggerClient::Object::BindChannelRequest->new(); # BindChannelRequest | schema and connection to bind to data channel
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $channel = ; # DataChannelReference | data channel configuration path encoded as path param of form 'path=\,category=\'

eval { 
    my $result = $api_instance->bindChannel(body => $body, sandbox => $sandbox, project => $project, channel => $channel);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChannelApi->bindChannel: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChannelApi()
body =  # BindChannelRequest | schema and connection to bind to data channel
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
channel =  # DataChannelReference | data channel configuration path encoded as path param of form 'path=\,category=\'

try: 
    # Bind a schema to a data channel
    api_response = api_instance.bind_channel(body, sandbox, project, channel)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChannelApi->bindChannel: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
channel*
DataChannelReference
data channel configuration path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Bound data channel on success

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Binding failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


createChannel

Create a new data channel

Create a new data channel.


/channels/{sandbox}/{project}

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/channels/{sandbox}/{project}"
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();

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


        ChannelApi apiInstance = new ChannelApi();
        CreateChannelRequest body = ; // CreateChannelRequest | data channel creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createChannel(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChannelApi#createChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChannelApi;

public class ChannelApiExample {

    public static void main(String[] args) {
        ChannelApi apiInstance = new ChannelApi();
        CreateChannelRequest body = ; // CreateChannelRequest | data channel creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createChannel(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChannelApi#createChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
CreateChannelRequest *body = ; // data channel creation parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Create a new data channel
[apiInstance createChannelWith:body
    sandbox:sandbox
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ChannelApi()
var body = ; // {{CreateChannelRequest}} data channel creation parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ChannelApi();
            var body = new CreateChannelRequest(); // CreateChannelRequest | data channel creation parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Create a new data channel
                apiInstance.createChannel(body, sandbox, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelApi.createChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiChannelApi();
$body = ; // CreateChannelRequest | data channel creation parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try {
    $api_instance->createChannel($body, $sandbox, $project);
} catch (Exception $e) {
    echo 'Exception when calling ChannelApi->createChannel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChannelApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChannelApi->new();
my $body = WWW::SwaggerClient::Object::CreateChannelRequest->new(); # CreateChannelRequest | data channel creation parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    $api_instance->createChannel(body => $body, sandbox => $sandbox, project => $project);
};
if ($@) {
    warn "Exception when calling ChannelApi->createChannel: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChannelApi()
body =  # CreateChannelRequest | data channel creation parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Create a new data channel
    api_instance.create_channel(body, sandbox, project)
except ApiException as e:
    print("Exception when calling ChannelApi->createChannel: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getChannels

Get all data channel definitions in a project

Get all data channel definitions in a project


/channels/{sandbox}/{project}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/channels/{sandbox}/{project}"
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();

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


        ChannelApi apiInstance = new ChannelApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[DataChannel] result = apiInstance.getChannels(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChannelApi#getChannels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChannelApi;

public class ChannelApiExample {

    public static void main(String[] args) {
        ChannelApi apiInstance = new ChannelApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[DataChannel] result = apiInstance.getChannels(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChannelApi#getChannels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Get all data channel definitions in a project
[apiInstance getChannelsWith:sandbox
    project:project
              completionHandler: ^(array[DataChannel] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ChannelApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ChannelApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Get all data channel definitions in a project
                array[DataChannel] result = apiInstance.getChannels(sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelApi.getChannels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiChannelApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChannelApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->getChannels(sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChannelApi->getChannels: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChannelApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Get all data channel definitions in a project
    api_response = api_instance.get_channels(sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChannelApi->getChannels: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required

Responses

Status: 200 - Data channel configurations in project

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


updateChannel

Update a data channel definition

Update a data channel. Support is provided for changing the channel type.


/channels/{sandbox}/{project}/{channel}

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/channels/{sandbox}/{project}/{channel}"
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();

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


        ChannelApi apiInstance = new ChannelApi();
        UpdateChannelRequest body = ; // UpdateChannelRequest | data channel update parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        DataChannelReference channel = ; // DataChannelReference | data channel configuration path encoded as path param of form 'path=\,category=\'
        try {
            DataChannel result = apiInstance.updateChannel(body, sandbox, project, channel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChannelApi#updateChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChannelApi;

public class ChannelApiExample {

    public static void main(String[] args) {
        ChannelApi apiInstance = new ChannelApi();
        UpdateChannelRequest body = ; // UpdateChannelRequest | data channel update parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        DataChannelReference channel = ; // DataChannelReference | data channel configuration path encoded as path param of form 'path=\,category=\'
        try {
            DataChannel result = apiInstance.updateChannel(body, sandbox, project, channel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChannelApi#updateChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
UpdateChannelRequest *body = ; // data channel update parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
DataChannelReference *channel = ; // data channel configuration path encoded as path param of form 'path=\,category=\'

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

// Update a data channel definition
[apiInstance updateChannelWith:body
    sandbox:sandbox
    project:project
    channel:channel
              completionHandler: ^(DataChannel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ChannelApi()
var body = ; // {{UpdateChannelRequest}} data channel update parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var channel = ; // {{DataChannelReference}} data channel configuration path encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new ChannelApi();
            var body = new UpdateChannelRequest(); // UpdateChannelRequest | data channel update parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var channel = new DataChannelReference(); // DataChannelReference | data channel configuration path encoded as path param of form 'path=\,category=\'

            try
            {
                // Update a data channel definition
                DataChannel result = apiInstance.updateChannel(body, sandbox, project, channel);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelApi.updateChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiChannelApi();
$body = ; // UpdateChannelRequest | data channel update parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$channel = ; // DataChannelReference | data channel configuration path encoded as path param of form 'path=\,category=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChannelApi->new();
my $body = WWW::SwaggerClient::Object::UpdateChannelRequest->new(); # UpdateChannelRequest | data channel update parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $channel = ; # DataChannelReference | data channel configuration path encoded as path param of form 'path=\,category=\'

eval { 
    my $result = $api_instance->updateChannel(body => $body, sandbox => $sandbox, project => $project, channel => $channel);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChannelApi->updateChannel: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChannelApi()
body =  # UpdateChannelRequest | data channel update parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
channel =  # DataChannelReference | data channel configuration path encoded as path param of form 'path=\,category=\'

try: 
    # Update a data channel definition
    api_response = api_instance.update_channel(body, sandbox, project, channel)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChannelApi->updateChannel: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
channel*
DataChannelReference
data channel configuration path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated data channel configuration

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


validateChannel

Validate a data channel definition

Perform data channel definition validation and return the validated definition. The data channel definition may be modified during validation.


/channels/{sandbox}/{project}/{channel}/validate

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/channels/{sandbox}/{project}/{channel}/validate?failOnWarnings="
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();

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


        ChannelApi apiInstance = new ChannelApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        DataChannelReference channel = ; // DataChannelReference | data channel definition path encoded as path param of form 'path=\,category=\'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            DataChannel result = apiInstance.validateChannel(sandbox, project, channel, failOnWarnings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChannelApi#validateChannel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChannelApi;

public class ChannelApiExample {

    public static void main(String[] args) {
        ChannelApi apiInstance = new ChannelApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        DataChannelReference channel = ; // DataChannelReference | data channel definition path encoded as path param of form 'path=\,category=\'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            DataChannel result = apiInstance.validateChannel(sandbox, project, channel, failOnWarnings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChannelApi#validateChannel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
DataChannelReference *channel = ; // data channel definition path encoded as path param of form 'path=\,category=\'
Boolean *failOnWarnings = true; // true to fail validation on warnings (optional) (default to false)

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

// Validate a data channel definition
[apiInstance validateChannelWith:sandbox
    project:project
    channel:channel
    failOnWarnings:failOnWarnings
              completionHandler: ^(DataChannel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ChannelApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var channel = ; // {{DataChannelReference}} data channel definition path encoded as path param of form 'path=\,category=\'
var opts = { 
  'failOnWarnings': true // {{Boolean}} true to fail validation on warnings
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateChannel(sandbox, project, channel, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ChannelApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var channel = new DataChannelReference(); // DataChannelReference | data channel definition path encoded as path param of form 'path=\,category=\'
            var failOnWarnings = true;  // Boolean | true to fail validation on warnings (optional)  (default to false)

            try
            {
                // Validate a data channel definition
                DataChannel result = apiInstance.validateChannel(sandbox, project, channel, failOnWarnings);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChannelApi.validateChannel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiChannelApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$channel = ; // DataChannelReference | data channel definition path encoded as path param of form 'path=\,category=\'
$failOnWarnings = true; // Boolean | true to fail validation on warnings

try {
    $result = $api_instance->validateChannel($sandbox, $project, $channel, $failOnWarnings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelApi->validateChannel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChannelApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChannelApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $channel = ; # DataChannelReference | data channel definition path encoded as path param of form 'path=\,category=\'
my $failOnWarnings = true; # Boolean | true to fail validation on warnings

eval { 
    my $result = $api_instance->validateChannel(sandbox => $sandbox, project => $project, channel => $channel, failOnWarnings => $failOnWarnings);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChannelApi->validateChannel: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChannelApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
channel =  # DataChannelReference | data channel definition path encoded as path param of form 'path=\,category=\'
failOnWarnings = true # Boolean | true to fail validation on warnings (optional) (default to false)

try: 
    # Validate a data channel definition
    api_response = api_instance.validate_channel(sandbox, project, channel, failOnWarnings=failOnWarnings)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChannelApi->validateChannel: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
channel*
DataChannelReference
data channel definition path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Query parameters
Name Description
failOnWarnings
Boolean
true to fail validation on warnings

Responses

Status: 200 - Validated data channel

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Artifact validation failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


Checkpoint

compareCheckpoints

Compare dirty projects in sandbox with a specific checkpoint

Compare dirty projects in sandbox with a checkpoint. The checkpoint must be an existing named checkpoint, or specify one of * *latest* - compare with the latest checkpoint. * *initial* - compare with initial sandbox state before any checkpoints


/checkpoints/{sandbox}/{checkpoint}/compare

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/plain,application/json"\
"/artifacts/v2/checkpoints/{sandbox}/{checkpoint}/compare"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckpointApi;

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

public class CheckpointApiExample {

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


        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        CheckpointReference checkpoint = ; // CheckpointReference | checkpoint name, either a specific checkpoint, *latest*, or *initial*.

        try {
            GitDiff result = apiInstance.compareCheckpoints(sandbox, checkpoint);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#compareCheckpoints");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckpointApi;

public class CheckpointApiExample {

    public static void main(String[] args) {
        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        CheckpointReference checkpoint = ; // CheckpointReference | checkpoint name, either a specific checkpoint, *latest*, or *initial*.

        try {
            GitDiff result = apiInstance.compareCheckpoints(sandbox, checkpoint);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#compareCheckpoints");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
CheckpointReference *checkpoint = ; // checkpoint name, either a specific checkpoint, *latest*, or *initial*.


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

// Compare dirty projects in sandbox with a specific checkpoint
[apiInstance compareCheckpointsWith:sandbox
    checkpoint:checkpoint
              completionHandler: ^(GitDiff output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.CheckpointApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var checkpoint = ; // {{CheckpointReference}} checkpoint name, either a specific checkpoint, *latest*, or *initial*.


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

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

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

            var apiInstance = new CheckpointApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var checkpoint = new CheckpointReference(); // CheckpointReference | checkpoint name, either a specific checkpoint, *latest*, or *initial*.


            try
            {
                // Compare dirty projects in sandbox with a specific checkpoint
                GitDiff result = apiInstance.compareCheckpoints(sandbox, checkpoint);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckpointApi.compareCheckpoints: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCheckpointApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$checkpoint = ; // CheckpointReference | checkpoint name, either a specific checkpoint, *latest*, or *initial*.


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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckpointApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $checkpoint = ; # CheckpointReference | checkpoint name, either a specific checkpoint, *latest*, or *initial*.


eval { 
    my $result = $api_instance->compareCheckpoints(sandbox => $sandbox, checkpoint => $checkpoint);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CheckpointApi->compareCheckpoints: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckpointApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
checkpoint =  # CheckpointReference | checkpoint name, either a specific checkpoint, *latest*, or *initial*.


try: 
    # Compare dirty projects in sandbox with a specific checkpoint
    api_response = api_instance.compare_checkpoints(sandbox, checkpoint)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CheckpointApi->compareCheckpoints: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
checkpoint*
CheckpointReference
checkpoint name, either a specific checkpoint, *latest*, or *initial*.
Required

Responses

Status: 200 - Compare results for all modified artifacts in a sandbox with the specified checkpoint. The compare results is a diff for each modified artifact. The format of the diff output is defined by the git diff command.

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


compareSandbox

Compare sandbox with backing spaces

Compare all projects in sandbox with backing spaces. There can be no dirty projects in the sandbox or the compare will fail.


/checkpoints/{sandbox}/compare

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/plain,application/json"\
"/artifacts/v2/checkpoints/{sandbox}/compare"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckpointApi;

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

public class CheckpointApiExample {

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


        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            GitDiff result = apiInstance.compareSandbox(sandbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#compareSandbox");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckpointApi;

public class CheckpointApiExample {

    public static void main(String[] args) {
        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            GitDiff result = apiInstance.compareSandbox(sandbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#compareSandbox");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'

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

// Compare sandbox with backing spaces
[apiInstance compareSandboxWith:sandbox
              completionHandler: ^(GitDiff output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.CheckpointApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'

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

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

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

            var apiInstance = new CheckpointApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

            try
            {
                // Compare sandbox with backing spaces
                GitDiff result = apiInstance.compareSandbox(sandbox);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckpointApi.compareSandbox: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCheckpointApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckpointApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

eval { 
    my $result = $api_instance->compareSandbox(sandbox => $sandbox);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CheckpointApi->compareSandbox: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckpointApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

try: 
    # Compare sandbox with backing spaces
    api_response = api_instance.compare_sandbox(sandbox)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CheckpointApi->compareSandbox: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required

Responses

Status: 200 - Compare results for all artifacts in a sandbox with the backing spaces. The compare results is a diff for each changed artifact. The format of the diff output is defined by the git diff command.

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - An invalid dirty project was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


createCheckpoint

Create a new checkpoint

Create a new checkpoint with checkpoint name in sandbox Projects in the checkpoint do not have to pass validation. Following a successful checkpoint a private dependency is available for all projects in the checkpoint. The generation of the private dependencies is done asychronously; they will not be complete when this operation completes.


/checkpoints/{sandbox}

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/checkpoints/{sandbox}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckpointApi;

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

public class CheckpointApiExample {

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


        CheckpointApi apiInstance = new CheckpointApi();
        CreateCheckpointRequest body = ; // CreateCheckpointRequest | checkpoint creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.createCheckpoint(body, sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#createCheckpoint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckpointApi;

public class CheckpointApiExample {

    public static void main(String[] args) {
        CheckpointApi apiInstance = new CheckpointApi();
        CreateCheckpointRequest body = ; // CreateCheckpointRequest | checkpoint creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.createCheckpoint(body, sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#createCheckpoint");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
CreateCheckpointRequest *body = ; // checkpoint creation parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'

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

// Create a new checkpoint
[apiInstance createCheckpointWith:body
    sandbox:sandbox
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.CheckpointApi()
var body = ; // {{CreateCheckpointRequest}} checkpoint creation parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'

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

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

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

            var apiInstance = new CheckpointApi();
            var body = new CreateCheckpointRequest(); // CreateCheckpointRequest | checkpoint creation parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

            try
            {
                // Create a new checkpoint
                apiInstance.createCheckpoint(body, sandbox);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckpointApi.createCheckpoint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCheckpointApi();
$body = ; // CreateCheckpointRequest | checkpoint creation parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckpointApi->new();
my $body = WWW::SwaggerClient::Object::CreateCheckpointRequest->new(); # CreateCheckpointRequest | checkpoint creation parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

eval { 
    $api_instance->createCheckpoint(body => $body, sandbox => $sandbox);
};
if ($@) {
    warn "Exception when calling CheckpointApi->createCheckpoint: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckpointApi()
body =  # CreateCheckpointRequest | checkpoint creation parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

try: 
    # Create a new checkpoint
    api_instance.create_checkpoint(body, sandbox)
except ApiException as e:
    print("Exception when calling CheckpointApi->createCheckpoint: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


discardSandbox

Discard all modifications

Discard all modified artifacts in a sandbox.


/checkpoints/{sandbox}/discard

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/checkpoints/{sandbox}/discard"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckpointApi;

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

public class CheckpointApiExample {

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


        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.discardSandbox(sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#discardSandbox");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckpointApi;

public class CheckpointApiExample {

    public static void main(String[] args) {
        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.discardSandbox(sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#discardSandbox");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'

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

// Discard all modifications
[apiInstance discardSandboxWith:sandbox
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.CheckpointApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'

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

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

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

            var apiInstance = new CheckpointApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

            try
            {
                // Discard all modifications
                apiInstance.discardSandbox(sandbox);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckpointApi.discardSandbox: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCheckpointApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckpointApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

eval { 
    $api_instance->discardSandbox(sandbox => $sandbox);
};
if ($@) {
    warn "Exception when calling CheckpointApi->discardSandbox: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckpointApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

try: 
    # Discard all modifications
    api_instance.discard_sandbox(sandbox)
except ApiException as e:
    print("Exception when calling CheckpointApi->discardSandbox: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required

Responses

Status: 200 - Discard successful

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getCheckpoints

Get checkpoints in sandbox

Get all checkpoints in sandbox


/checkpoints/{sandbox}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/checkpoints/{sandbox}?checkpoint[name]=&checkpoint[type]="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckpointApi;

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

public class CheckpointApiExample {

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


        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        String checkpoint[type] = checkpoint[type]_example; // String | 
        String checkpoint[name] = checkpoint[name]_example; // String | 
        try {
            array[Checkpoint] result = apiInstance.getCheckpoints(sandbox, checkpoint[type], checkpoint[name]);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#getCheckpoints");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckpointApi;

public class CheckpointApiExample {

    public static void main(String[] args) {
        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        String checkpoint[type] = checkpoint[type]_example; // String | 
        String checkpoint[name] = checkpoint[name]_example; // String | 
        try {
            array[Checkpoint] result = apiInstance.getCheckpoints(sandbox, checkpoint[type], checkpoint[name]);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#getCheckpoints");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
String *checkpoint[type] = checkpoint[type]_example; // 
String *checkpoint[name] = checkpoint[name]_example; //  (optional)

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

// Get checkpoints in sandbox
[apiInstance getCheckpointsWith:sandbox
    checkpoint[type]:checkpoint[type]
    checkpoint[name]:checkpoint[name]
              completionHandler: ^(array[Checkpoint] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.CheckpointApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var checkpoint[type] = checkpoint[type]_example; // {{String}} 
var opts = { 
  'checkpoint[name]': checkpoint[name]_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCheckpoints(sandbox, checkpoint[type], opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new CheckpointApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var checkpoint[type] = checkpoint[type]_example;  // String | 
            var checkpoint[name] = checkpoint[name]_example;  // String |  (optional) 

            try
            {
                // Get checkpoints in sandbox
                array[Checkpoint] result = apiInstance.getCheckpoints(sandbox, checkpoint[type], checkpoint[name]);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckpointApi.getCheckpoints: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCheckpointApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$checkpoint[type] = checkpoint[type]_example; // String | 
$checkpoint[name] = checkpoint[name]_example; // String | 

try {
    $result = $api_instance->getCheckpoints($sandbox, $checkpoint[type], $checkpoint[name]);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckpointApi->getCheckpoints: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CheckpointApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckpointApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $checkpoint[type] = checkpoint[type]_example; # String | 
my $checkpoint[name] = checkpoint[name]_example; # String | 

eval { 
    my $result = $api_instance->getCheckpoints(sandbox => $sandbox, checkpoint[type] => $checkpoint[type], checkpoint[name] => $checkpoint[name]);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CheckpointApi->getCheckpoints: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckpointApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
checkpoint[type] = checkpoint[type]_example # String | 
checkpoint[name] = checkpoint[name]_example # String |  (optional)

try: 
    # Get checkpoints in sandbox
    api_response = api_instance.get_checkpoints(sandbox, checkpoint[type], checkpoint[name]=checkpoint[name])
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CheckpointApi->getCheckpoints: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
Query parameters
Name Description
checkpoint[name]
String
checkpoint[type]*
String
Required

Responses

Status: 200 - Filtered checkpoints in sandbox

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


mergeSandbox

Merge sandbox with backing spaces

Merge backing spaces with sandbox. There can be no dirty projects in the sandbox or the merge will fail.


/checkpoints/{sandbox}/merge

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/checkpoints/{sandbox}/merge"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckpointApi;

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

public class CheckpointApiExample {

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


        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.mergeSandbox(sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#mergeSandbox");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckpointApi;

public class CheckpointApiExample {

    public static void main(String[] args) {
        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.mergeSandbox(sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#mergeSandbox");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'

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

// Merge sandbox with backing spaces
[apiInstance mergeSandboxWith:sandbox
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.CheckpointApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'

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

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

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

            var apiInstance = new CheckpointApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

            try
            {
                // Merge sandbox with backing spaces
                apiInstance.mergeSandbox(sandbox);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckpointApi.mergeSandbox: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCheckpointApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckpointApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

eval { 
    $api_instance->mergeSandbox(sandbox => $sandbox);
};
if ($@) {
    warn "Exception when calling CheckpointApi->mergeSandbox: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckpointApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

try: 
    # Merge sandbox with backing spaces
    api_instance.merge_sandbox(sandbox)
except ApiException as e:
    print("Exception when calling CheckpointApi->mergeSandbox: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required

Responses

Status: 200 - Merge successful

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - An error merging space with sandbox

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


publishCheckpoint

Publish a checkpoint

Publish a checkpoint to the backing space. The checkpoint must be an existing checkpoint name, or specify *latest* to publish the latest checkpoint. The checkpoint being published must pass validation. Following a successful publish, a public dependency is available for all projects in the checkpoint. Backing space updates and generation of public dependencies is done asychronously; they will not be complete when this operation completes.


/checkpoints/{sandbox}/{checkpoint}/publish

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/checkpoints/{sandbox}/{checkpoint}/publish"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckpointApi;

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

public class CheckpointApiExample {

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


        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        CheckpointReference checkpoint = ; // CheckpointReference | checkpoint name, either a specific checkpoint or *latest* to publish the latest checkpoint
        try {
            apiInstance.publishCheckpoint(sandbox, checkpoint);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#publishCheckpoint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckpointApi;

public class CheckpointApiExample {

    public static void main(String[] args) {
        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        CheckpointReference checkpoint = ; // CheckpointReference | checkpoint name, either a specific checkpoint or *latest* to publish the latest checkpoint
        try {
            apiInstance.publishCheckpoint(sandbox, checkpoint);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#publishCheckpoint");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
CheckpointReference *checkpoint = ; // checkpoint name, either a specific checkpoint or *latest* to publish the latest checkpoint

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

// Publish a checkpoint
[apiInstance publishCheckpointWith:sandbox
    checkpoint:checkpoint
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.CheckpointApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var checkpoint = ; // {{CheckpointReference}} checkpoint name, either a specific checkpoint or *latest* to publish the latest checkpoint

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

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

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

            var apiInstance = new CheckpointApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var checkpoint = new CheckpointReference(); // CheckpointReference | checkpoint name, either a specific checkpoint or *latest* to publish the latest checkpoint

            try
            {
                // Publish a checkpoint
                apiInstance.publishCheckpoint(sandbox, checkpoint);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckpointApi.publishCheckpoint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCheckpointApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$checkpoint = ; // CheckpointReference | checkpoint name, either a specific checkpoint or *latest* to publish the latest checkpoint

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckpointApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $checkpoint = ; # CheckpointReference | checkpoint name, either a specific checkpoint or *latest* to publish the latest checkpoint

eval { 
    $api_instance->publishCheckpoint(sandbox => $sandbox, checkpoint => $checkpoint);
};
if ($@) {
    warn "Exception when calling CheckpointApi->publishCheckpoint: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckpointApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
checkpoint =  # CheckpointReference | checkpoint name, either a specific checkpoint or *latest* to publish the latest checkpoint

try: 
    # Publish a checkpoint
    api_instance.publish_checkpoint(sandbox, checkpoint)
except ApiException as e:
    print("Exception when calling CheckpointApi->publishCheckpoint: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
checkpoint*
CheckpointReference
checkpoint name, either a specific checkpoint or *latest* to publish the latest checkpoint
Required

Responses

Status: 200 - Checkpoint succesfully published

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Artifact validation failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


resetCheckpoint

Reset sandbox to a specific checkpoint

Reset sandbox to checkpoint. Any existing modifications in the sandbox are untouched. Any other checkpoints in the sandbox are unmodified. When going back to an earlier checkpoint, changes from later checkpoints are preserved as pending.


/checkpoints/{sandbox}/{checkpoint}/reset

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/checkpoints/{sandbox}/{checkpoint}/reset"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckpointApi;

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

public class CheckpointApiExample {

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


        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        CheckpointReference checkpoint = ; // CheckpointReference | checkpoint name
        try {
            apiInstance.resetCheckpoint(sandbox, checkpoint);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#resetCheckpoint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckpointApi;

public class CheckpointApiExample {

    public static void main(String[] args) {
        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        CheckpointReference checkpoint = ; // CheckpointReference | checkpoint name
        try {
            apiInstance.resetCheckpoint(sandbox, checkpoint);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#resetCheckpoint");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
CheckpointReference *checkpoint = ; // checkpoint name

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

// Reset sandbox to a specific checkpoint
[apiInstance resetCheckpointWith:sandbox
    checkpoint:checkpoint
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.CheckpointApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var checkpoint = ; // {{CheckpointReference}} checkpoint name

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

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

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

            var apiInstance = new CheckpointApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var checkpoint = new CheckpointReference(); // CheckpointReference | checkpoint name

            try
            {
                // Reset sandbox to a specific checkpoint
                apiInstance.resetCheckpoint(sandbox, checkpoint);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckpointApi.resetCheckpoint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCheckpointApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$checkpoint = ; // CheckpointReference | checkpoint name

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckpointApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $checkpoint = ; # CheckpointReference | checkpoint name

eval { 
    $api_instance->resetCheckpoint(sandbox => $sandbox, checkpoint => $checkpoint);
};
if ($@) {
    warn "Exception when calling CheckpointApi->resetCheckpoint: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckpointApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
checkpoint =  # CheckpointReference | checkpoint name

try: 
    # Reset sandbox to a specific checkpoint
    api_instance.reset_checkpoint(sandbox, checkpoint)
except ApiException as e:
    print("Exception when calling CheckpointApi->resetCheckpoint: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
checkpoint*
CheckpointReference
checkpoint name
Required

Responses

Status: 200 - Sandbox successfully reset to checkpoint

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


resetSandbox

Reset sandbox to state before any checkpoints.

Reset sandbox to state before any checkpoints. Any modified artifacts in the sandbox are untouched. All checkpoints are deleted; changes from any checkpoints are preserved as pending. All projects in the sandbox are synchronized with their backing space on success.


/checkpoints/{sandbox}/reset

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/checkpoints/{sandbox}/reset"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckpointApi;

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

public class CheckpointApiExample {

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


        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.resetSandbox(sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#resetSandbox");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckpointApi;

public class CheckpointApiExample {

    public static void main(String[] args) {
        CheckpointApi apiInstance = new CheckpointApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.resetSandbox(sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckpointApi#resetSandbox");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'

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

// Reset sandbox to state before any checkpoints.
[apiInstance resetSandboxWith:sandbox
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.CheckpointApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'

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

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

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

            var apiInstance = new CheckpointApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

            try
            {
                // Reset sandbox to state before any checkpoints.
                apiInstance.resetSandbox(sandbox);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckpointApi.resetSandbox: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiCheckpointApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckpointApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

eval { 
    $api_instance->resetSandbox(sandbox => $sandbox);
};
if ($@) {
    warn "Exception when calling CheckpointApi->resetSandbox: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckpointApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

try: 
    # Reset sandbox to state before any checkpoints.
    api_instance.reset_sandbox(sandbox)
except ApiException as e:
    print("Exception when calling CheckpointApi->resetSandbox: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required

Responses

Status: 200 - Reset successful

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


Dependency

getArtifactsInDependency

Get artifacts in a dependency

Get artifacts in a dependency, optionally omitting _large_ content The returned artifacts may include any which may exist in a project, including *ManagedFile*, *DataChannel*, *Flow*, *Model*, *Pipeline*, *TupleSchema*, *CloudDeployDescriptor*, and/or *StreamingDeployDescriptor*. If the *content* query parameter is set to *false* (default value), Model.content and ManagedFile.content are omitted from the response. No other data is removed from these, or other, artifacts. Setting the *content* query parameter to *true* returns all content. Omitting content minimizes the size of the response if the data is not needed. NOTE: this endpoint uses the POST method because of the complexity of the parameter, making it unreasonable to put the Dependency into the URL with a GET, which whould be a more standard API.


/dependencies/artifacts

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/dependencies/artifacts?content="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DependencyApi;

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

public class DependencyApiExample {

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


        DependencyApi apiInstance = new DependencyApi();
        Dependency body = ; // Dependency | get artifacts contained in this dependency
        Boolean content = true; // Boolean | include _large_ content in response?
        try {
            array[Artifact] result = apiInstance.getArtifactsInDependency(body, content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DependencyApi#getArtifactsInDependency");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DependencyApi;

public class DependencyApiExample {

    public static void main(String[] args) {
        DependencyApi apiInstance = new DependencyApi();
        Dependency body = ; // Dependency | get artifacts contained in this dependency
        Boolean content = true; // Boolean | include _large_ content in response?
        try {
            array[Artifact] result = apiInstance.getArtifactsInDependency(body, content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DependencyApi#getArtifactsInDependency");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
Dependency *body = ; // get artifacts contained in this dependency
Boolean *content = true; // include _large_ content in response? (optional) (default to false)

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

// Get artifacts in a dependency
[apiInstance getArtifactsInDependencyWith:body
    content:content
              completionHandler: ^(array[Artifact] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DependencyApi()
var body = ; // {{Dependency}} get artifacts contained in this dependency
var opts = { 
  'content': true // {{Boolean}} include _large_ content in response?
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArtifactsInDependency(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new DependencyApi();
            var body = new Dependency(); // Dependency | get artifacts contained in this dependency
            var content = true;  // Boolean | include _large_ content in response? (optional)  (default to false)

            try
            {
                // Get artifacts in a dependency
                array[Artifact] result = apiInstance.getArtifactsInDependency(body, content);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DependencyApi.getArtifactsInDependency: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDependencyApi();
$body = ; // Dependency | get artifacts contained in this dependency
$content = true; // Boolean | include _large_ content in response?

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DependencyApi->new();
my $body = WWW::SwaggerClient::Object::Dependency->new(); # Dependency | get artifacts contained in this dependency
my $content = true; # Boolean | include _large_ content in response?

eval { 
    my $result = $api_instance->getArtifactsInDependency(body => $body, content => $content);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DependencyApi->getArtifactsInDependency: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DependencyApi()
body =  # Dependency | get artifacts contained in this dependency
content = true # Boolean | include _large_ content in response? (optional) (default to false)

try: 
    # Get artifacts in a dependency
    api_response = api_instance.get_artifacts_in_dependency(body, content=content)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DependencyApi->getArtifactsInDependency: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
content
Boolean
include _large_ content in response?

Responses

Status: 200 - Contained artifacts

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getPrivateDependencies

Get private sandbox dependencies

Get private sandbox dependencies, optionally filtering only to the dependencies for the project specified by the project query parameter or the dependencies that contain the artifact specified by the path query parameter. If both of the filters are specified then only the dependencies that satisfy both filters are returned. If no dependencies are found an empty array is returned. Dependencies are used as both project dependencies and the target of a deploy. Public dependencies are not included in the returned dependencies. NOTE: this endpoint uses the POST method because of the complexity of the parameters, making it unreasonable to put the filters into the URL with a GET, which whould be a more standard API.


/dependencies/{sandbox}

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/dependencies/{sandbox}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DependencyApi;

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

public class DependencyApiExample {

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


        DependencyApi apiInstance = new DependencyApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        DependencyFilter body = ; // DependencyFilter | Optional filter to only include dependencies for a
given project, and/or containing a given artifact

        try {
            array[Dependency] result = apiInstance.getPrivateDependencies(sandbox, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DependencyApi#getPrivateDependencies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DependencyApi;

public class DependencyApiExample {

    public static void main(String[] args) {
        DependencyApi apiInstance = new DependencyApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        DependencyFilter body = ; // DependencyFilter | Optional filter to only include dependencies for a
given project, and/or containing a given artifact

        try {
            array[Dependency] result = apiInstance.getPrivateDependencies(sandbox, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DependencyApi#getPrivateDependencies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
DependencyFilter *body = ; // Optional filter to only include dependencies for a
given project, and/or containing a given artifact
 (optional)

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

// Get private sandbox dependencies
[apiInstance getPrivateDependenciesWith:sandbox
    body:body
              completionHandler: ^(array[Dependency] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DependencyApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var opts = { 
  'body':  // {{DependencyFilter}} Optional filter to only include dependencies for a
given project, and/or containing a given artifact

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

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

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

            var apiInstance = new DependencyApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var body = new DependencyFilter(); // DependencyFilter | Optional filter to only include dependencies for a
given project, and/or containing a given artifact
 (optional) 

            try
            {
                // Get private sandbox dependencies
                array[Dependency] result = apiInstance.getPrivateDependencies(sandbox, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DependencyApi.getPrivateDependencies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDependencyApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$body = ; // DependencyFilter | Optional filter to only include dependencies for a
given project, and/or containing a given artifact


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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DependencyApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $body = WWW::SwaggerClient::Object::DependencyFilter->new(); # DependencyFilter | Optional filter to only include dependencies for a
given project, and/or containing a given artifact


eval { 
    my $result = $api_instance->getPrivateDependencies(sandbox => $sandbox, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DependencyApi->getPrivateDependencies: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DependencyApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
body =  # DependencyFilter | Optional filter to only include dependencies for a
given project, and/or containing a given artifact
 (optional)

try: 
    # Get private sandbox dependencies
    api_response = api_instance.get_private_dependencies(sandbox, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DependencyApi->getPrivateDependencies: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
Body parameters
Name Description
body

Responses

Status: 200 - Private sandbox dependencies

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getPublicDependencies

Get public dependencies

Get public dependencies, optionally filtering only to the dependencies for the project specified by the project query parameter or the dependencies that contain the artifact specified by the path query parameter. If both of the filters are specified then only the dependencies that satisfy both filters are returned. If no dependencies are found an empty array is returned. Dependencies are used as both project dependencies and the target of a deploy. NOTE: this endpoint uses the POST method because of the complexity of the parameters, making it unreasonable to put the filters into the URL with a GET, which whould be a more standard API.


/dependencies

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/dependencies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DependencyApi;

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

public class DependencyApiExample {

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


        DependencyApi apiInstance = new DependencyApi();
        DependencyFilter body = ; // DependencyFilter | Optional filter to only include dependencies for a
given project, and/or containing a given artifact

        try {
            array[Dependency] result = apiInstance.getPublicDependencies(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DependencyApi#getPublicDependencies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DependencyApi;

public class DependencyApiExample {

    public static void main(String[] args) {
        DependencyApi apiInstance = new DependencyApi();
        DependencyFilter body = ; // DependencyFilter | Optional filter to only include dependencies for a
given project, and/or containing a given artifact

        try {
            array[Dependency] result = apiInstance.getPublicDependencies(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DependencyApi#getPublicDependencies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
DependencyFilter *body = ; // Optional filter to only include dependencies for a
given project, and/or containing a given artifact
 (optional)

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

// Get public dependencies
[apiInstance getPublicDependenciesWith:body
              completionHandler: ^(array[Dependency] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DependencyApi()
var opts = { 
  'body':  // {{DependencyFilter}} Optional filter to only include dependencies for a
given project, and/or containing a given artifact

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

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

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

            var apiInstance = new DependencyApi();
            var body = new DependencyFilter(); // DependencyFilter | Optional filter to only include dependencies for a
given project, and/or containing a given artifact
 (optional) 

            try
            {
                // Get public dependencies
                array[Dependency] result = apiInstance.getPublicDependencies(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DependencyApi.getPublicDependencies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDependencyApi();
$body = ; // DependencyFilter | Optional filter to only include dependencies for a
given project, and/or containing a given artifact


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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DependencyApi->new();
my $body = WWW::SwaggerClient::Object::DependencyFilter->new(); # DependencyFilter | Optional filter to only include dependencies for a
given project, and/or containing a given artifact


eval { 
    my $result = $api_instance->getPublicDependencies(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DependencyApi->getPublicDependencies: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DependencyApi()
body =  # DependencyFilter | Optional filter to only include dependencies for a
given project, and/or containing a given artifact
 (optional)

try: 
    # Get public dependencies
    api_response = api_instance.get_public_dependencies(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DependencyApi->getPublicDependencies: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Available public dependencies

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


getTransitiveDependencies

Get transitive dependencies for a dependency

Recursively returns all transitive dependencies for the specified dependency. An empty array is returned if the dependency does not have any transitive dependencies. For example, if project A has a dependency on project B which has a dependency on project C which has a dependency on Project D, invoking this API with POST /dependencies/transitive[A] would return four TransitiveDependency records with this content: * A --> B * B --> C * C --> D * D NOTE: this endpoint uses the POST method because of the complexity of the parameter, making it unreasonable to put the Dependency into the URL with a GET, which whould be a more standard API.


/dependencies/transitive

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/dependencies/transitive"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DependencyApi;

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

public class DependencyApiExample {

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


        DependencyApi apiInstance = new DependencyApi();
        Dependency body = ; // Dependency | get transitive dependencies for this dependency
        try {
            array[TransitiveDependency] result = apiInstance.getTransitiveDependencies(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DependencyApi#getTransitiveDependencies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DependencyApi;

public class DependencyApiExample {

    public static void main(String[] args) {
        DependencyApi apiInstance = new DependencyApi();
        Dependency body = ; // Dependency | get transitive dependencies for this dependency
        try {
            array[TransitiveDependency] result = apiInstance.getTransitiveDependencies(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DependencyApi#getTransitiveDependencies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
Dependency *body = ; // get transitive dependencies for this dependency

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

// Get transitive dependencies for a dependency
[apiInstance getTransitiveDependenciesWith:body
              completionHandler: ^(array[TransitiveDependency] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DependencyApi()
var body = ; // {{Dependency}} get transitive dependencies for this dependency

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

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

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

            var apiInstance = new DependencyApi();
            var body = new Dependency(); // Dependency | get transitive dependencies for this dependency

            try
            {
                // Get transitive dependencies for a dependency
                array[TransitiveDependency] result = apiInstance.getTransitiveDependencies(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DependencyApi.getTransitiveDependencies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDependencyApi();
$body = ; // Dependency | get transitive dependencies for this dependency

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DependencyApi->new();
my $body = WWW::SwaggerClient::Object::Dependency->new(); # Dependency | get transitive dependencies for this dependency

eval { 
    my $result = $api_instance->getTransitiveDependencies(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DependencyApi->getTransitiveDependencies: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DependencyApi()
body =  # Dependency | get transitive dependencies for this dependency

try: 
    # Get transitive dependencies for a dependency
    api_response = api_instance.get_transitive_dependencies(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DependencyApi->getTransitiveDependencies: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Transitive dependencies

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


Deploy

deploy

deploy a project

Deploy a project. A built dependency (aka built project) must be specified to deploy a project. The deployment descriptor in the project defines how to deploy the project. The project being deployed must pass validation. The failOnWarnings property controls whether deploy will fail on validation warnings or not. By default warnings cause deployment to fail. This operation starts the deployment and returns a resource identifier for the deployment. The resource identifier for the deployment is valid until the deployment completes, is canceled, or fails. While a deployment is starting, the *DeployContext.status* property has a value of *pending* and *ProgressNotification* events are periodically sent to report on progress until startup is complete. The name used when deploying must be unique within the environment or cluster where the deployment is occuring for the login user. The same name can be used by another user in the same environment or cluster. A user can reuse the same name in the same environment or cluster once the deployment completes successfully, fails, or is canceled. The project must be approved for deployment to the target cloud resource (either an environment or a streaming cluster).


/deploy

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/deploy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeployApi;

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

public class DeployApiExample {

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


        DeployApi apiInstance = new DeployApi();
        DeployRequest body = ; // DeployRequest | deployment properties
        try {
            InProgress result = apiInstance.deploy(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#deploy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeployApi;

public class DeployApiExample {

    public static void main(String[] args) {
        DeployApi apiInstance = new DeployApi();
        DeployRequest body = ; // DeployRequest | deployment properties
        try {
            InProgress result = apiInstance.deploy(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#deploy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
DeployRequest *body = ; // deployment properties

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

// deploy a project
[apiInstance deployWith:body
              completionHandler: ^(InProgress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DeployApi()
var body = ; // {{DeployRequest}} deployment properties

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

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

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

            var apiInstance = new DeployApi();
            var body = new DeployRequest(); // DeployRequest | deployment properties

            try
            {
                // deploy a project
                InProgress result = apiInstance.deploy(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeployApi.deploy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDeployApi();
$body = ; // DeployRequest | deployment properties

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeployApi->new();
my $body = WWW::SwaggerClient::Object::DeployRequest->new(); # DeployRequest | deployment properties

eval { 
    my $result = $api_instance->deploy(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeployApi->deploy: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeployApi()
body =  # DeployRequest | deployment properties

try: 
    # deploy a project
    api_response = api_instance.deploy(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeployApi->deploy: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 202 - Operation is in progress. *ProgressNotification* events are periodically sent for the operation that returned *InProgress* until the operation is complete.

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 500 - Internal server error, contact support


getDeploy

Get a deploy context

Get the deployment context for a deploy identifier. The deploy identifier is invalid once the returned deploy context has an ExecutionStatus of COMPLETED or ERROR. A resource does not exist error is returned if no deployment context with specified identifier exists or user does not have read access.


/deploy/{identifier}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/deploy/{identifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeployApi;

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

public class DeployApiExample {

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


        DeployApi apiInstance = new DeployApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'
        try {
            DeployContexts result = apiInstance.getDeploy(identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#getDeploy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeployApi;

public class DeployApiExample {

    public static void main(String[] args) {
        DeployApi apiInstance = new DeployApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'
        try {
            DeployContexts result = apiInstance.getDeploy(identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#getDeploy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
ResourceIdentifier *identifier = ; // Deploy identifier encoded as path param of form 'identifier=\'

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

// Get a deploy context
[apiInstance getDeployWith:identifier
              completionHandler: ^(DeployContexts output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DeployApi()
var identifier = ; // {{ResourceIdentifier}} Deploy identifier encoded as path param of form 'identifier=\'

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

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

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

            var apiInstance = new DeployApi();
            var identifier = new ResourceIdentifier(); // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'

            try
            {
                // Get a deploy context
                DeployContexts result = apiInstance.getDeploy(identifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeployApi.getDeploy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDeployApi();
$identifier = ; // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeployApi->new();
my $identifier = ; # ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'

eval { 
    my $result = $api_instance->getDeploy(identifier => $identifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeployApi->getDeploy: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeployApi()
identifier =  # ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'

try: 
    # Get a deploy context
    api_response = api_instance.get_deploy(identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeployApi->getDeploy: %s\n" % e)

Parameters

Path parameters
Name Description
identifier*
ResourceIdentifier
Deploy identifier encoded as path param of form 'identifier=\<identifier\>'
Required

Responses

Status: 200 - deploy context

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getDeployedChannels

Details on deployed (running) data channels

Get details on all deployed data channels. All running data channels are visible to all authenticated users; there are no authorization permissions enforced. Optional filtering values can be passed in the request body. All values passed in the filter are used as a logical conjunction (&amp;&amp;) when determining which values to return. NOTE: this endpoint uses the POST method because of the complexity of the query options, making it unreasonable to put the query options into the URL with a GET, which whould be a more standard API.


/deploy/channels

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/deploy/channels"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeployApi;

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

public class DeployApiExample {

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


        DeployApi apiInstance = new DeployApi();
        DataChannelFilter body = ; // DataChannelFilter | Data channel filter options

        try {
            array[DataChannelInformation] result = apiInstance.getDeployedChannels(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#getDeployedChannels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeployApi;

public class DeployApiExample {

    public static void main(String[] args) {
        DeployApi apiInstance = new DeployApi();
        DataChannelFilter body = ; // DataChannelFilter | Data channel filter options

        try {
            array[DataChannelInformation] result = apiInstance.getDeployedChannels(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#getDeployedChannels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
DataChannelFilter *body = ; // Data channel filter options
 (optional)

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

// Details on deployed (running) data channels
[apiInstance getDeployedChannelsWith:body
              completionHandler: ^(array[DataChannelInformation] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DeployApi()
var opts = { 
  'body':  // {{DataChannelFilter}} Data channel filter options

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

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

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

            var apiInstance = new DeployApi();
            var body = new DataChannelFilter(); // DataChannelFilter | Data channel filter options
 (optional) 

            try
            {
                // Details on deployed (running) data channels
                array[DataChannelInformation] result = apiInstance.getDeployedChannels(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeployApi.getDeployedChannels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDeployApi();
$body = ; // DataChannelFilter | Data channel filter options


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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeployApi->new();
my $body = WWW::SwaggerClient::Object::DataChannelFilter->new(); # DataChannelFilter | Data channel filter options


eval { 
    my $result = $api_instance->getDeployedChannels(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeployApi->getDeployedChannels: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeployApi()
body =  # DataChannelFilter | Data channel filter options
 (optional)

try: 
    # Details on deployed (running) data channels
    api_response = api_instance.get_deployed_channels(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeployApi->getDeployedChannels: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Running data channels

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getDeploys

Get deployments

Get all deployments visible to the login user Optional filtering values can be passed in the query string. All values passed in the filter are used as a logical conjunction (&amp;&amp;) when determining which values to return.


/deploy

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/deploy?name[name]=&deployedBy=&projectIdentifier[groupIdentifier]=&projectIdentifier[artifactIdentifier]=&projectIdentifier[name]=&projectVersion[major]=&projectVersion[minor]=&projectVersion[patch]=&projectVersion[label]=&executionStatus=&trace=&executionResourceName[name]=&executionResourceName[type]="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeployApi;

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

public class DeployApiExample {

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


        DeployApi apiInstance = new DeployApi();
        String name[name] = name[name]_example; // String | 
        String projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; // String | 
        String projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; // String | 
        Integer projectVersion[major] = 56; // Integer | 
        Integer projectVersion[minor] = 56; // Integer | 
        Integer projectVersion[patch] = 56; // Integer | 
        String executionResourceName[name] = executionResourceName[name]_example; // String | 
        String executionResourceName[type] = executionResourceName[type]_example; // String | 
        String deployedBy = deployedBy_example; // String | deployed by user name
        String projectIdentifier[name] = projectIdentifier[name]_example; // String | 
        String projectVersion[label] = projectVersion[label]_example; // String | 
        ExecutionStatus executionStatus = ; // ExecutionStatus | execution status
        Trace trace = ; // Trace | trace status
        try {
            array[DeployContexts] result = apiInstance.getDeploys(name[name], projectIdentifier[groupIdentifier], projectIdentifier[artifactIdentifier], projectVersion[major], projectVersion[minor], projectVersion[patch], executionResourceName[name], executionResourceName[type], deployedBy, projectIdentifier[name], projectVersion[label], executionStatus, trace);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#getDeploys");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeployApi;

public class DeployApiExample {

    public static void main(String[] args) {
        DeployApi apiInstance = new DeployApi();
        String name[name] = name[name]_example; // String | 
        String projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; // String | 
        String projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; // String | 
        Integer projectVersion[major] = 56; // Integer | 
        Integer projectVersion[minor] = 56; // Integer | 
        Integer projectVersion[patch] = 56; // Integer | 
        String executionResourceName[name] = executionResourceName[name]_example; // String | 
        String executionResourceName[type] = executionResourceName[type]_example; // String | 
        String deployedBy = deployedBy_example; // String | deployed by user name
        String projectIdentifier[name] = projectIdentifier[name]_example; // String | 
        String projectVersion[label] = projectVersion[label]_example; // String | 
        ExecutionStatus executionStatus = ; // ExecutionStatus | execution status
        Trace trace = ; // Trace | trace status
        try {
            array[DeployContexts] result = apiInstance.getDeploys(name[name], projectIdentifier[groupIdentifier], projectIdentifier[artifactIdentifier], projectVersion[major], projectVersion[minor], projectVersion[patch], executionResourceName[name], executionResourceName[type], deployedBy, projectIdentifier[name], projectVersion[label], executionStatus, trace);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#getDeploys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
String *name[name] = name[name]_example; // 
String *projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; // 
String *projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; // 
Integer *projectVersion[major] = 56; // 
Integer *projectVersion[minor] = 56; // 
Integer *projectVersion[patch] = 56; // 
String *executionResourceName[name] = executionResourceName[name]_example; // 
String *executionResourceName[type] = executionResourceName[type]_example; // 
String *deployedBy = deployedBy_example; // deployed by user name (optional)
String *projectIdentifier[name] = projectIdentifier[name]_example; //  (optional)
String *projectVersion[label] = projectVersion[label]_example; //  (optional)
ExecutionStatus *executionStatus = ; // execution status (optional)
Trace *trace = ; // trace status (optional)

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

// Get deployments
[apiInstance getDeploysWith:name[name]
    projectIdentifier[groupIdentifier]:projectIdentifier[groupIdentifier]
    projectIdentifier[artifactIdentifier]:projectIdentifier[artifactIdentifier]
    projectVersion[major]:projectVersion[major]
    projectVersion[minor]:projectVersion[minor]
    projectVersion[patch]:projectVersion[patch]
    executionResourceName[name]:executionResourceName[name]
    executionResourceName[type]:executionResourceName[type]
    deployedBy:deployedBy
    projectIdentifier[name]:projectIdentifier[name]
    projectVersion[label]:projectVersion[label]
    executionStatus:executionStatus
    trace:trace
              completionHandler: ^(array[DeployContexts] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DeployApi()
var name[name] = name[name]_example; // {{String}} 
var projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; // {{String}} 
var projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; // {{String}} 
var projectVersion[major] = 56; // {{Integer}} 
var projectVersion[minor] = 56; // {{Integer}} 
var projectVersion[patch] = 56; // {{Integer}} 
var executionResourceName[name] = executionResourceName[name]_example; // {{String}} 
var executionResourceName[type] = executionResourceName[type]_example; // {{String}} 
var opts = { 
  'deployedBy': deployedBy_example, // {{String}} deployed by user name
  'projectIdentifier[name]': projectIdentifier[name]_example, // {{String}} 
  'projectVersion[label]': projectVersion[label]_example, // {{String}} 
  'executionStatus': , // {{ExecutionStatus}} execution status
  'trace':  // {{Trace}} trace status
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeploys(name[name], projectIdentifier[groupIdentifier], projectIdentifier[artifactIdentifier], projectVersion[major], projectVersion[minor], projectVersion[patch], executionResourceName[name], executionResourceName[type], opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new DeployApi();
            var name[name] = name[name]_example;  // String | 
            var projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example;  // String | 
            var projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example;  // String | 
            var projectVersion[major] = 56;  // Integer | 
            var projectVersion[minor] = 56;  // Integer | 
            var projectVersion[patch] = 56;  // Integer | 
            var executionResourceName[name] = executionResourceName[name]_example;  // String | 
            var executionResourceName[type] = executionResourceName[type]_example;  // String | 
            var deployedBy = deployedBy_example;  // String | deployed by user name (optional) 
            var projectIdentifier[name] = projectIdentifier[name]_example;  // String |  (optional) 
            var projectVersion[label] = projectVersion[label]_example;  // String |  (optional) 
            var executionStatus = new ExecutionStatus(); // ExecutionStatus | execution status (optional) 
            var trace = new Trace(); // Trace | trace status (optional) 

            try
            {
                // Get deployments
                array[DeployContexts] result = apiInstance.getDeploys(name[name], projectIdentifier[groupIdentifier], projectIdentifier[artifactIdentifier], projectVersion[major], projectVersion[minor], projectVersion[patch], executionResourceName[name], executionResourceName[type], deployedBy, projectIdentifier[name], projectVersion[label], executionStatus, trace);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeployApi.getDeploys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDeployApi();
$name[name] = name[name]_example; // String | 
$projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; // String | 
$projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; // String | 
$projectVersion[major] = 56; // Integer | 
$projectVersion[minor] = 56; // Integer | 
$projectVersion[patch] = 56; // Integer | 
$executionResourceName[name] = executionResourceName[name]_example; // String | 
$executionResourceName[type] = executionResourceName[type]_example; // String | 
$deployedBy = deployedBy_example; // String | deployed by user name
$projectIdentifier[name] = projectIdentifier[name]_example; // String | 
$projectVersion[label] = projectVersion[label]_example; // String | 
$executionStatus = ; // ExecutionStatus | execution status
$trace = ; // Trace | trace status

try {
    $result = $api_instance->getDeploys($name[name], $projectIdentifier[groupIdentifier], $projectIdentifier[artifactIdentifier], $projectVersion[major], $projectVersion[minor], $projectVersion[patch], $executionResourceName[name], $executionResourceName[type], $deployedBy, $projectIdentifier[name], $projectVersion[label], $executionStatus, $trace);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeployApi->getDeploys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeployApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeployApi->new();
my $name[name] = name[name]_example; # String | 
my $projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example; # String | 
my $projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example; # String | 
my $projectVersion[major] = 56; # Integer | 
my $projectVersion[minor] = 56; # Integer | 
my $projectVersion[patch] = 56; # Integer | 
my $executionResourceName[name] = executionResourceName[name]_example; # String | 
my $executionResourceName[type] = executionResourceName[type]_example; # String | 
my $deployedBy = deployedBy_example; # String | deployed by user name
my $projectIdentifier[name] = projectIdentifier[name]_example; # String | 
my $projectVersion[label] = projectVersion[label]_example; # String | 
my $executionStatus = ; # ExecutionStatus | execution status
my $trace = ; # Trace | trace status

eval { 
    my $result = $api_instance->getDeploys(name[name] => $name[name], projectIdentifier[groupIdentifier] => $projectIdentifier[groupIdentifier], projectIdentifier[artifactIdentifier] => $projectIdentifier[artifactIdentifier], projectVersion[major] => $projectVersion[major], projectVersion[minor] => $projectVersion[minor], projectVersion[patch] => $projectVersion[patch], executionResourceName[name] => $executionResourceName[name], executionResourceName[type] => $executionResourceName[type], deployedBy => $deployedBy, projectIdentifier[name] => $projectIdentifier[name], projectVersion[label] => $projectVersion[label], executionStatus => $executionStatus, trace => $trace);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeployApi->getDeploys: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeployApi()
name[name] = name[name]_example # String | 
projectIdentifier[groupIdentifier] = projectIdentifier[groupIdentifier]_example # String | 
projectIdentifier[artifactIdentifier] = projectIdentifier[artifactIdentifier]_example # String | 
projectVersion[major] = 56 # Integer | 
projectVersion[minor] = 56 # Integer | 
projectVersion[patch] = 56 # Integer | 
executionResourceName[name] = executionResourceName[name]_example # String | 
executionResourceName[type] = executionResourceName[type]_example # String | 
deployedBy = deployedBy_example # String | deployed by user name (optional)
projectIdentifier[name] = projectIdentifier[name]_example # String |  (optional)
projectVersion[label] = projectVersion[label]_example # String |  (optional)
executionStatus =  # ExecutionStatus | execution status (optional)
trace =  # Trace | trace status (optional)

try: 
    # Get deployments
    api_response = api_instance.get_deploys(name[name], projectIdentifier[groupIdentifier], projectIdentifier[artifactIdentifier], projectVersion[major], projectVersion[minor], projectVersion[patch], executionResourceName[name], executionResourceName[type], deployedBy=deployedBy, projectIdentifier[name]=projectIdentifier[name], projectVersion[label]=projectVersion[label], executionStatus=executionStatus, trace=trace)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeployApi->getDeploys: %s\n" % e)

Parameters

Query parameters
Name Description
name[name]*
String
Required
deployedBy
String
deployed by user name
projectIdentifier[groupIdentifier]*
String
Required
projectIdentifier[artifactIdentifier]*
String
Required
projectIdentifier[name]
String
projectVersion[major]*
Integer (int32)
Required
projectVersion[minor]*
Integer (int32)
Required
projectVersion[patch]*
Integer (int32)
Required
projectVersion[label]
String
executionStatus
ExecutionStatus
execution status
trace
Trace
trace status
executionResourceName[name]*
String
Required
executionResourceName[type]*
String
Required

Responses

Status: 200 - Deploy contexts

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


shutdownDeploy

Shutdown a running deployment

Shutdown a running deployment. The ExecutionStatus in the deploy context is set to SHUTDOWN and the deploy identifier is no longer valid on successful completion.


/deploy/{identifier}

Usage and SDK Samples

curl -X DELETE\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/deploy/{identifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeployApi;

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

public class DeployApiExample {

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


        DeployApi apiInstance = new DeployApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'
        try {
            InProgress result = apiInstance.shutdownDeploy(identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#shutdownDeploy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeployApi;

public class DeployApiExample {

    public static void main(String[] args) {
        DeployApi apiInstance = new DeployApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'
        try {
            InProgress result = apiInstance.shutdownDeploy(identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#shutdownDeploy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
ResourceIdentifier *identifier = ; // Deploy identifier encoded as path param of form 'identifier=\'

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

// Shutdown a running deployment
[apiInstance shutdownDeployWith:identifier
              completionHandler: ^(InProgress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DeployApi()
var identifier = ; // {{ResourceIdentifier}} Deploy identifier encoded as path param of form 'identifier=\'

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

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

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

            var apiInstance = new DeployApi();
            var identifier = new ResourceIdentifier(); // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'

            try
            {
                // Shutdown a running deployment
                InProgress result = apiInstance.shutdownDeploy(identifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeployApi.shutdownDeploy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDeployApi();
$identifier = ; // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeployApi->new();
my $identifier = ; # ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'

eval { 
    my $result = $api_instance->shutdownDeploy(identifier => $identifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeployApi->shutdownDeploy: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeployApi()
identifier =  # ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'

try: 
    # Shutdown a running deployment
    api_response = api_instance.shutdown_deploy(identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeployApi->shutdownDeploy: %s\n" % e)

Parameters

Path parameters
Name Description
identifier*
ResourceIdentifier
Deploy identifier encoded as path param of form 'identifier=\<identifier\>'
Required

Responses

Status: 202 - Operation is in progress. *ProgressNotification* events are periodically sent for the operation that returned *InProgress* until the operation is complete.

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


traceDeploy

Change trace state for current session for deployment

Change the tracing state for the current session. Tracing is controlled per session. This operation quietly does nothing if the deployment is already in the requested trace state for the login user.


/deploy/{identifier}/trace

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/deploy/{identifier}/trace?trace="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeployApi;

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

public class DeployApiExample {

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


        DeployApi apiInstance = new DeployApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'
        Trace trace = ; // Trace | Set trace state to this value
        try {
            DeployContexts result = apiInstance.traceDeploy(identifier, trace);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#traceDeploy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeployApi;

public class DeployApiExample {

    public static void main(String[] args) {
        DeployApi apiInstance = new DeployApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'
        Trace trace = ; // Trace | Set trace state to this value
        try {
            DeployContexts result = apiInstance.traceDeploy(identifier, trace);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#traceDeploy");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
ResourceIdentifier *identifier = ; // Deploy identifier encoded as path param of form 'identifier=\'
Trace *trace = ; // Set trace state to this value

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

// Change trace state for current session for deployment
[apiInstance traceDeployWith:identifier
    trace:trace
              completionHandler: ^(DeployContexts output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DeployApi()
var identifier = ; // {{ResourceIdentifier}} Deploy identifier encoded as path param of form 'identifier=\'
var trace = ; // {{Trace}} Set trace state to this value

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

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

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

            var apiInstance = new DeployApi();
            var identifier = new ResourceIdentifier(); // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'
            var trace = new Trace(); // Trace | Set trace state to this value

            try
            {
                // Change trace state for current session for deployment
                DeployContexts result = apiInstance.traceDeploy(identifier, trace);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeployApi.traceDeploy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDeployApi();
$identifier = ; // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'
$trace = ; // Trace | Set trace state to this value

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeployApi->new();
my $identifier = ; # ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'
my $trace = ; # Trace | Set trace state to this value

eval { 
    my $result = $api_instance->traceDeploy(identifier => $identifier, trace => $trace);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeployApi->traceDeploy: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeployApi()
identifier =  # ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'
trace =  # Trace | Set trace state to this value

try: 
    # Change trace state for current session for deployment
    api_response = api_instance.trace_deploy(identifier, trace)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeployApi->traceDeploy: %s\n" % e)

Parameters

Path parameters
Name Description
identifier*
ResourceIdentifier
Deploy identifier encoded as path param of form 'identifier=\<identifier\>'
Required
Query parameters
Name Description
trace*
Trace
Set trace state to this value
Required

Responses

Status: 200 - trace state was successfully set

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - An error changing trace state of a deployment

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


update

Update a running deployment

Update a running deployment. The project version can be the same, or different, than the deployment being upgraded. The API supports updating to any available version. These cases are supported: * version is less than running version - rollback/restore to a previous version * version equals running version - only during development when updating a private dependency * version is greater than running version - update to a newer version To perform an update the deployment must still be running. The project being updated must pass validation. The failOnWarnings property controls whether the upgrade will fail on validation warnings or not. By default warnings cause the upgrade to fail. A resource identifier for the deployment being updated is returned. The caller of this operation should not assume that the update request identifier is the same as the original deployment identifier passed in to this operation. While a deployment is updating, the *DeployContext.status* property has a value of *pending* and *ProgressNotification* events are periodically sent to report on progress until update is complete. Update status is determined using GET /deploy/{identifier}.


/deploy/{identifier}/update

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/deploy/{identifier}/update"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeployApi;

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

public class DeployApiExample {

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


        DeployApi apiInstance = new DeployApi();
        UpdateRequest body = ; // UpdateRequest | deployment properties
        ResourceIdentifier identifier = ; // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'
        try {
            InProgress result = apiInstance.update(body, identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#update");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeployApi;

public class DeployApiExample {

    public static void main(String[] args) {
        DeployApi apiInstance = new DeployApi();
        UpdateRequest body = ; // UpdateRequest | deployment properties
        ResourceIdentifier identifier = ; // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'
        try {
            InProgress result = apiInstance.update(body, identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeployApi#update");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
UpdateRequest *body = ; // deployment properties
ResourceIdentifier *identifier = ; // Deploy identifier encoded as path param of form 'identifier=\'

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

// Update a running deployment
[apiInstance updateWith:body
    identifier:identifier
              completionHandler: ^(InProgress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DeployApi()
var body = ; // {{UpdateRequest}} deployment properties
var identifier = ; // {{ResourceIdentifier}} Deploy identifier encoded as path param of form 'identifier=\'

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

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

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

            var apiInstance = new DeployApi();
            var body = new UpdateRequest(); // UpdateRequest | deployment properties
            var identifier = new ResourceIdentifier(); // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'

            try
            {
                // Update a running deployment
                InProgress result = apiInstance.update(body, identifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeployApi.update: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDeployApi();
$body = ; // UpdateRequest | deployment properties
$identifier = ; // ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DeployApi->new();
my $body = WWW::SwaggerClient::Object::UpdateRequest->new(); # UpdateRequest | deployment properties
my $identifier = ; # ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'

eval { 
    my $result = $api_instance->update(body => $body, identifier => $identifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeployApi->update: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DeployApi()
body =  # UpdateRequest | deployment properties
identifier =  # ResourceIdentifier | Deploy identifier encoded as path param of form 'identifier=\'

try: 
    # Update a running deployment
    api_response = api_instance.update(body, identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeployApi->update: %s\n" % e)

Parameters

Path parameters
Name Description
identifier*
ResourceIdentifier
Deploy identifier encoded as path param of form 'identifier=\<identifier\>'
Required
Body parameters
Name Description
body *

Responses

Status: 202 - Operation is in progress. *ProgressNotification* events are periodically sent for the operation that returned *InProgress* until the operation is complete.

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - The requested update is not supported

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


Descriptor

createDescriptor

Create a new deployment descriptor

Create a new deployment descriptor.


/descriptors/{sandbox}/{project}

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/descriptors/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescriptorApi;

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

public class DescriptorApiExample {

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


        DescriptorApi apiInstance = new DescriptorApi();
        CreateDescriptorRequest body = ; // CreateDescriptorRequest | deploy descriptor creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createDescriptor(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorApi#createDescriptor");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescriptorApi;

public class DescriptorApiExample {

    public static void main(String[] args) {
        DescriptorApi apiInstance = new DescriptorApi();
        CreateDescriptorRequest body = ; // CreateDescriptorRequest | deploy descriptor creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createDescriptor(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorApi#createDescriptor");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
CreateDescriptorRequest *body = ; // deploy descriptor creation parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Create a new deployment descriptor
[apiInstance createDescriptorWith:body
    sandbox:sandbox
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DescriptorApi()
var body = ; // {{CreateDescriptorRequest}} deploy descriptor creation parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new DescriptorApi();
            var body = new CreateDescriptorRequest(); // CreateDescriptorRequest | deploy descriptor creation parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Create a new deployment descriptor
                apiInstance.createDescriptor(body, sandbox, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescriptorApi.createDescriptor: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDescriptorApi();
$body = ; // CreateDescriptorRequest | deploy descriptor creation parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try {
    $api_instance->createDescriptor($body, $sandbox, $project);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorApi->createDescriptor: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescriptorApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DescriptorApi->new();
my $body = WWW::SwaggerClient::Object::CreateDescriptorRequest->new(); # CreateDescriptorRequest | deploy descriptor creation parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    $api_instance->createDescriptor(body => $body, sandbox => $sandbox, project => $project);
};
if ($@) {
    warn "Exception when calling DescriptorApi->createDescriptor: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DescriptorApi()
body =  # CreateDescriptorRequest | deploy descriptor creation parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Create a new deployment descriptor
    api_instance.create_descriptor(body, sandbox, project)
except ApiException as e:
    print("Exception when calling DescriptorApi->createDescriptor: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getDescriptor

Get project deploy descriptor

Get the deployment descriptor for the project. Every project has one deployment descriptor.


/descriptors/{sandbox}/{project}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/descriptors/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescriptorApi;

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

public class DescriptorApiExample {

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


        DescriptorApi apiInstance = new DescriptorApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            DeployDescriptors result = apiInstance.getDescriptor(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorApi#getDescriptor");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescriptorApi;

public class DescriptorApiExample {

    public static void main(String[] args) {
        DescriptorApi apiInstance = new DescriptorApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            DeployDescriptors result = apiInstance.getDescriptor(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorApi#getDescriptor");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Get project deploy descriptor
[apiInstance getDescriptorWith:sandbox
    project:project
              completionHandler: ^(DeployDescriptors output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DescriptorApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new DescriptorApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Get project deploy descriptor
                DeployDescriptors result = apiInstance.getDescriptor(sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescriptorApi.getDescriptor: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDescriptorApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DescriptorApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->getDescriptor(sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorApi->getDescriptor: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DescriptorApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Get project deploy descriptor
    api_response = api_instance.get_descriptor(sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorApi->getDescriptor: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required

Responses

Status: 200 - Project deployment descriptor

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


updateDescriptor

Update a deployment descriptor

Update a deployment descriptor


/descriptors/{sandbox}/{project}

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/descriptors/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescriptorApi;

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

public class DescriptorApiExample {

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


        DescriptorApi apiInstance = new DescriptorApi();
        UpdateDescriptorRequest body = ; // UpdateDescriptorRequest | deployment descriptor update parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            DeployDescriptors result = apiInstance.updateDescriptor(body, sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorApi#updateDescriptor");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescriptorApi;

public class DescriptorApiExample {

    public static void main(String[] args) {
        DescriptorApi apiInstance = new DescriptorApi();
        UpdateDescriptorRequest body = ; // UpdateDescriptorRequest | deployment descriptor update parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            DeployDescriptors result = apiInstance.updateDescriptor(body, sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorApi#updateDescriptor");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
UpdateDescriptorRequest *body = ; // deployment descriptor update parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Update a deployment descriptor
[apiInstance updateDescriptorWith:body
    sandbox:sandbox
    project:project
              completionHandler: ^(DeployDescriptors output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DescriptorApi()
var body = ; // {{UpdateDescriptorRequest}} deployment descriptor update parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new DescriptorApi();
            var body = new UpdateDescriptorRequest(); // UpdateDescriptorRequest | deployment descriptor update parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Update a deployment descriptor
                DeployDescriptors result = apiInstance.updateDescriptor(body, sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescriptorApi.updateDescriptor: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDescriptorApi();
$body = ; // UpdateDescriptorRequest | deployment descriptor update parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DescriptorApi->new();
my $body = WWW::SwaggerClient::Object::UpdateDescriptorRequest->new(); # UpdateDescriptorRequest | deployment descriptor update parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->updateDescriptor(body => $body, sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorApi->updateDescriptor: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DescriptorApi()
body =  # UpdateDescriptorRequest | deployment descriptor update parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Update a deployment descriptor
    api_response = api_instance.update_descriptor(body, sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorApi->updateDescriptor: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated deployment descriptor

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


validateDescriptor

Validate a deployment descriptor

Perform descriptor validation and return the validated descriptor. Descriptors may be modified during validation.


/descriptors/{sandbox}/{project}/validate

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/descriptors/{sandbox}/{project}/validate?failOnWarnings="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DescriptorApi;

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

public class DescriptorApiExample {

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


        DescriptorApi apiInstance = new DescriptorApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            DeployDescriptors result = apiInstance.validateDescriptor(sandbox, project, failOnWarnings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorApi#validateDescriptor");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DescriptorApi;

public class DescriptorApiExample {

    public static void main(String[] args) {
        DescriptorApi apiInstance = new DescriptorApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            DeployDescriptors result = apiInstance.validateDescriptor(sandbox, project, failOnWarnings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DescriptorApi#validateDescriptor");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
Boolean *failOnWarnings = true; // true to fail validation on warnings (optional) (default to false)

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

// Validate a deployment descriptor
[apiInstance validateDescriptorWith:sandbox
    project:project
    failOnWarnings:failOnWarnings
              completionHandler: ^(DeployDescriptors output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.DescriptorApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var opts = { 
  'failOnWarnings': true // {{Boolean}} true to fail validation on warnings
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateDescriptor(sandbox, project, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new DescriptorApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var failOnWarnings = true;  // Boolean | true to fail validation on warnings (optional)  (default to false)

            try
            {
                // Validate a deployment descriptor
                DeployDescriptors result = apiInstance.validateDescriptor(sandbox, project, failOnWarnings);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DescriptorApi.validateDescriptor: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDescriptorApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$failOnWarnings = true; // Boolean | true to fail validation on warnings

try {
    $result = $api_instance->validateDescriptor($sandbox, $project, $failOnWarnings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DescriptorApi->validateDescriptor: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DescriptorApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DescriptorApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $failOnWarnings = true; # Boolean | true to fail validation on warnings

eval { 
    my $result = $api_instance->validateDescriptor(sandbox => $sandbox, project => $project, failOnWarnings => $failOnWarnings);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DescriptorApi->validateDescriptor: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DescriptorApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
failOnWarnings = true # Boolean | true to fail validation on warnings (optional) (default to false)

try: 
    # Validate a deployment descriptor
    api_response = api_instance.validate_descriptor(sandbox, project, failOnWarnings=failOnWarnings)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DescriptorApi->validateDescriptor: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Query parameters
Name Description
failOnWarnings
Boolean
true to fail validation on warnings

Responses

Status: 200 - Validated descriptor

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Artifact validation failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


File

createFile

Create a new managed file

Create a new managed file. Managed file content is opaque and has no special processing associated with it.


/files/{sandbox}/{project}

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"/artifacts/v2/files/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileApi;

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

public class FileApiExample {

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


        FileApi apiInstance = new FileApi();
        RelativePath path = ; // RelativePath | 
        ArtifactTypeReference type = ; // ArtifactTypeReference | 
        byte[] content = content_example; // byte[] | 
        Attributes attributes = ; // Attributes | 
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createFile(path, type, content, attributes, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileApi#createFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileApi;

public class FileApiExample {

    public static void main(String[] args) {
        FileApi apiInstance = new FileApi();
        RelativePath path = ; // RelativePath | 
        ArtifactTypeReference type = ; // ArtifactTypeReference | 
        byte[] content = content_example; // byte[] | 
        Attributes attributes = ; // Attributes | 
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createFile(path, type, content, attributes, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileApi#createFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
RelativePath *path = ; // 
ArtifactTypeReference *type = ; // 
byte[] *content = content_example; // 
Attributes *attributes = ; // 
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Create a new managed file
[apiInstance createFileWith:path
    type:type
    content:content
    attributes:attributes
    sandbox:sandbox
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.FileApi()
var path = ; // {{RelativePath}} 
var type = ; // {{ArtifactTypeReference}} 
var content = content_example; // {{byte[]}} 
var attributes = ; // {{Attributes}} 
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new FileApi();
            var path = new RelativePath(); // RelativePath | 
            var type = new ArtifactTypeReference(); // ArtifactTypeReference | 
            var content = content_example;  // byte[] | 
            var attributes = new Attributes(); // Attributes | 
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Create a new managed file
                apiInstance.createFile(path, type, content, attributes, sandbox, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileApi.createFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiFileApi();
$path = ; // RelativePath | 
$type = ; // ArtifactTypeReference | 
$content = content_example; // byte[] | 
$attributes = ; // Attributes | 
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try {
    $api_instance->createFile($path, $type, $content, $attributes, $sandbox, $project);
} catch (Exception $e) {
    echo 'Exception when calling FileApi->createFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileApi->new();
my $path = ; # RelativePath | 
my $type = ; # ArtifactTypeReference | 
my $content = content_example; # byte[] | 
my $attributes = ; # Attributes | 
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    $api_instance->createFile(path => $path, type => $type, content => $content, attributes => $attributes, sandbox => $sandbox, project => $project);
};
if ($@) {
    warn "Exception when calling FileApi->createFile: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileApi()
path =  # RelativePath | 
type =  # ArtifactTypeReference | 
content = content_example # byte[] | 
attributes =  # Attributes | 
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Create a new managed file
    api_instance.create_file(path, type, content, attributes, sandbox, project)
except ApiException as e:
    print("Exception when calling FileApi->createFile: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Form parameters
Name Description
path*
RelativePath
Required
type*
ArtifactTypeReference
Required
content*
byte[] (binary)
Required
attributes*
Attributes
Required

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getFiles

Get all managed files in a project

Get all managed files in a project. The file content is not returned from this call. Use GET /projects/{sandbox}/{project}/artifacts/{reference} to fetch the file content if needed.


/files/{sandbox}/{project}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/files/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileApi;

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

public class FileApiExample {

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


        FileApi apiInstance = new FileApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[ManagedFile] result = apiInstance.getFiles(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileApi#getFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileApi;

public class FileApiExample {

    public static void main(String[] args) {
        FileApi apiInstance = new FileApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[ManagedFile] result = apiInstance.getFiles(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileApi#getFiles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Get all managed files in a project
[apiInstance getFilesWith:sandbox
    project:project
              completionHandler: ^(array[ManagedFile] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.FileApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new FileApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Get all managed files in a project
                array[ManagedFile] result = apiInstance.getFiles(sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileApi.getFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiFileApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->getFiles(sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileApi->getFiles: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Get all managed files in a project
    api_response = api_instance.get_files(sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileApi->getFiles: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required

Responses

Status: 200 - Managed files in project

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


updateFile

Update a managed file

Replace the contents of a managed file. The updated file is not returned from this call. Use GET /projects/{sandbox}/{project}/artifacts/{path} to refetch the file if needed.


/files/{sandbox}/{project}/{file}

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"/artifacts/v2/files/{sandbox}/{project}/{file}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileApi;

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

public class FileApiExample {

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


        FileApi apiInstance = new FileApi();
        byte[] content = content_example; // byte[] | 
        Attributes attributes = ; // Attributes | 
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ManagedFileReference file = ; // ManagedFileReference | file path encoded as path param of form 'path=\,category=\'
        try {
            apiInstance.updateFile(content, attributes, sandbox, project, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileApi#updateFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FileApi;

public class FileApiExample {

    public static void main(String[] args) {
        FileApi apiInstance = new FileApi();
        byte[] content = content_example; // byte[] | 
        Attributes attributes = ; // Attributes | 
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ManagedFileReference file = ; // ManagedFileReference | file path encoded as path param of form 'path=\,category=\'
        try {
            apiInstance.updateFile(content, attributes, sandbox, project, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileApi#updateFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
byte[] *content = content_example; // 
Attributes *attributes = ; // 
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
ManagedFileReference *file = ; // file path encoded as path param of form 'path=\,category=\'

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

// Update a managed file
[apiInstance updateFileWith:content
    attributes:attributes
    sandbox:sandbox
    project:project
    file:file
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.FileApi()
var content = content_example; // {{byte[]}} 
var attributes = ; // {{Attributes}} 
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var file = ; // {{ManagedFileReference}} file path encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new FileApi();
            var content = content_example;  // byte[] | 
            var attributes = new Attributes(); // Attributes | 
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var file = new ManagedFileReference(); // ManagedFileReference | file path encoded as path param of form 'path=\,category=\'

            try
            {
                // Update a managed file
                apiInstance.updateFile(content, attributes, sandbox, project, file);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileApi.updateFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiFileApi();
$content = content_example; // byte[] | 
$attributes = ; // Attributes | 
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$file = ; // ManagedFileReference | file path encoded as path param of form 'path=\,category=\'

try {
    $api_instance->updateFile($content, $attributes, $sandbox, $project, $file);
} catch (Exception $e) {
    echo 'Exception when calling FileApi->updateFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FileApi->new();
my $content = content_example; # byte[] | 
my $attributes = ; # Attributes | 
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $file = ; # ManagedFileReference | file path encoded as path param of form 'path=\,category=\'

eval { 
    $api_instance->updateFile(content => $content, attributes => $attributes, sandbox => $sandbox, project => $project, file => $file);
};
if ($@) {
    warn "Exception when calling FileApi->updateFile: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FileApi()
content = content_example # byte[] | 
attributes =  # Attributes | 
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
file =  # ManagedFileReference | file path encoded as path param of form 'path=\,category=\'

try: 
    # Update a managed file
    api_instance.update_file(content, attributes, sandbox, project, file)
except ApiException as e:
    print("Exception when calling FileApi->updateFile: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
file*
ManagedFileReference
file path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Form parameters
Name Description
content*
byte[] (binary)
Required
attributes*
Attributes
Required

Responses

Status: 200 - managed file successfully updated

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


Flow

createFlow

Create a new flow

Create a new flow.


/flows/{sandbox}/{project}

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/flows/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlowApi;

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

public class FlowApiExample {

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


        FlowApi apiInstance = new FlowApi();
        CreateFlowRequest body = ; // CreateFlowRequest | flow creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createFlow(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowApi#createFlow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FlowApi;

public class FlowApiExample {

    public static void main(String[] args) {
        FlowApi apiInstance = new FlowApi();
        CreateFlowRequest body = ; // CreateFlowRequest | flow creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createFlow(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowApi#createFlow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
CreateFlowRequest *body = ; // flow creation parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Create a new flow
[apiInstance createFlowWith:body
    sandbox:sandbox
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.FlowApi()
var body = ; // {{CreateFlowRequest}} flow creation parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new FlowApi();
            var body = new CreateFlowRequest(); // CreateFlowRequest | flow creation parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Create a new flow
                apiInstance.createFlow(body, sandbox, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlowApi.createFlow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiFlowApi();
$body = ; // CreateFlowRequest | flow creation parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try {
    $api_instance->createFlow($body, $sandbox, $project);
} catch (Exception $e) {
    echo 'Exception when calling FlowApi->createFlow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FlowApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FlowApi->new();
my $body = WWW::SwaggerClient::Object::CreateFlowRequest->new(); # CreateFlowRequest | flow creation parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    $api_instance->createFlow(body => $body, sandbox => $sandbox, project => $project);
};
if ($@) {
    warn "Exception when calling FlowApi->createFlow: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FlowApi()
body =  # CreateFlowRequest | flow creation parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Create a new flow
    api_instance.create_flow(body, sandbox, project)
except ApiException as e:
    print("Exception when calling FlowApi->createFlow: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


edgeLanguageServer

Create a flow edge language server WebSocket endpoint

This is a Language Server Protocol WebSocket session accessed using the ws: protocol. After HTTP upgrade, the client will have a WebSocket that can send and receive JSON-RPC messages using the Language Server Protocol specification to manage flow edge transformation expressions.


/flows/edge-language-server

Usage and SDK Samples

curl -X GET\
\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/flows/edge-language-server?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlowApi;

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

public class FlowApiExample {

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

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

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


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

public class FlowApiExample {

    public static void main(String[] args) {
        FlowApi apiInstance = new FlowApi();
        try {
            apiInstance.edgeLanguageServer();
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowApi#edgeLanguageServer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiQueryTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];

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

// Create a flow edge language server WebSocket endpoint
[apiInstance edgeLanguageServerWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.ApiClient.instance;

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

// 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-Streaming-Web-API-Token'] = "Token"


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

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

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

            var apiInstance = new FlowApi();

            try
            {
                // Create a flow edge language server WebSocket endpoint
                apiInstance.edgeLanguageServer();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlowApi.edgeLanguageServer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

# Configure API key authorization: ApiQueryTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";
# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

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

eval { 
    $api_instance->edgeLanguageServer();
};
if ($@) {
    warn "Exception when calling FlowApi->edgeLanguageServer: $@\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: ApiQueryTokenKey
swagger_client.configuration.api_key['X-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'
# Configure API key authorization: ApiTokenKey
swagger_client.configuration.api_key['X-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

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

try: 
    # Create a flow edge language server WebSocket endpoint
    api_instance.edge_language_server()
except ApiException as e:
    print("Exception when calling FlowApi->edgeLanguageServer: %s\n" % e)

Parameters

Query parameters
Name Description

Responses

Status: 200 - Language Server Protocol JSON-RPC message stream

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


getFlowStepInfo

Get information about a particular flow step type.

Get information about a particular flow step type. Caller must provide a flow step configuration, since that impacts the information returned. This operation is a POST rather than a GET because it requires a request body containing the flow step configuration.


/flows/{sandbox}/{project}/step/{id}

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/flows/{sandbox}/{project}/step/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlowApi;

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

public class FlowApiExample {

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


        FlowApi apiInstance = new FlowApi();
        map[String, Object] body = ; // map[String, Object] | flow step configuration
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ExtensionReference id = ; // ExtensionReference | extension reference describing the desired flow step
        try {
            array[FlowStepDescription] result = apiInstance.getFlowStepInfo(body, sandbox, project, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowApi#getFlowStepInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FlowApi;

public class FlowApiExample {

    public static void main(String[] args) {
        FlowApi apiInstance = new FlowApi();
        map[String, Object] body = ; // map[String, Object] | flow step configuration
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ExtensionReference id = ; // ExtensionReference | extension reference describing the desired flow step
        try {
            array[FlowStepDescription] result = apiInstance.getFlowStepInfo(body, sandbox, project, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowApi#getFlowStepInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
map[String, Object] *body = ; // flow step configuration
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
ExtensionReference *id = ; // extension reference describing the desired flow step

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

// Get information about a particular flow step type.
[apiInstance getFlowStepInfoWith:body
    sandbox:sandbox
    project:project
    id:id
              completionHandler: ^(array[FlowStepDescription] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.FlowApi()
var body = ; // {{map[String, Object]}} flow step configuration
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var id = ; // {{ExtensionReference}} extension reference describing the desired flow step

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

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

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

            var apiInstance = new FlowApi();
            var body = new map[String, Object](); // map[String, Object] | flow step configuration
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var id = new ExtensionReference(); // ExtensionReference | extension reference describing the desired flow step

            try
            {
                // Get information about a particular flow step type.
                array[FlowStepDescription] result = apiInstance.getFlowStepInfo(body, sandbox, project, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlowApi.getFlowStepInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiFlowApi();
$body = ; // map[String, Object] | flow step configuration
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$id = ; // ExtensionReference | extension reference describing the desired flow step

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FlowApi->new();
my $body = WWW::SwaggerClient::Object::map[String, Object]->new(); # map[String, Object] | flow step configuration
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $id = ; # ExtensionReference | extension reference describing the desired flow step

eval { 
    my $result = $api_instance->getFlowStepInfo(body => $body, sandbox => $sandbox, project => $project, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowApi->getFlowStepInfo: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FlowApi()
body =  # map[String, Object] | flow step configuration
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
id =  # ExtensionReference | extension reference describing the desired flow step

try: 
    # Get information about a particular flow step type.
    api_response = api_instance.get_flow_step_info(body, sandbox, project, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowApi->getFlowStepInfo: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
id*
ExtensionReference
extension reference describing the desired flow step
Required
Body parameters
Name Description
body *

Responses

Status: 200 - FLow step information

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getFlows

Get all flows in a project

Get all flows in a project


/flows/{sandbox}/{project}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/flows/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlowApi;

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

public class FlowApiExample {

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


        FlowApi apiInstance = new FlowApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[Flow] result = apiInstance.getFlows(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowApi#getFlows");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FlowApi;

public class FlowApiExample {

    public static void main(String[] args) {
        FlowApi apiInstance = new FlowApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[Flow] result = apiInstance.getFlows(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowApi#getFlows");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Get all flows in a project
[apiInstance getFlowsWith:sandbox
    project:project
              completionHandler: ^(array[Flow] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.FlowApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new FlowApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Get all flows in a project
                array[Flow] result = apiInstance.getFlows(sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlowApi.getFlows: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiFlowApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FlowApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->getFlows(sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowApi->getFlows: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FlowApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Get all flows in a project
    api_response = api_instance.get_flows(sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowApi->getFlows: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required

Responses

Status: 200 - Flows in project

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


updateFlow

Update a flow

Update a flow


/flows/{sandbox}/{project}/{flow}

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/flows/{sandbox}/{project}/{flow}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlowApi;

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

public class FlowApiExample {

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


        FlowApi apiInstance = new FlowApi();
        UpdateFlowRequest body = ; // UpdateFlowRequest | flow update parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        FlowReference flow = ; // FlowReference | flow path encoded as path param of form 'path=\,category=\'
        try {
            Flow result = apiInstance.updateFlow(body, sandbox, project, flow);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowApi#updateFlow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FlowApi;

public class FlowApiExample {

    public static void main(String[] args) {
        FlowApi apiInstance = new FlowApi();
        UpdateFlowRequest body = ; // UpdateFlowRequest | flow update parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        FlowReference flow = ; // FlowReference | flow path encoded as path param of form 'path=\,category=\'
        try {
            Flow result = apiInstance.updateFlow(body, sandbox, project, flow);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowApi#updateFlow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
UpdateFlowRequest *body = ; // flow update parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
FlowReference *flow = ; // flow path encoded as path param of form 'path=\,category=\'

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

// Update a flow
[apiInstance updateFlowWith:body
    sandbox:sandbox
    project:project
    flow:flow
              completionHandler: ^(Flow output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.FlowApi()
var body = ; // {{UpdateFlowRequest}} flow update parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var flow = ; // {{FlowReference}} flow path encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new FlowApi();
            var body = new UpdateFlowRequest(); // UpdateFlowRequest | flow update parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var flow = new FlowReference(); // FlowReference | flow path encoded as path param of form 'path=\,category=\'

            try
            {
                // Update a flow
                Flow result = apiInstance.updateFlow(body, sandbox, project, flow);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlowApi.updateFlow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiFlowApi();
$body = ; // UpdateFlowRequest | flow update parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$flow = ; // FlowReference | flow path encoded as path param of form 'path=\,category=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FlowApi->new();
my $body = WWW::SwaggerClient::Object::UpdateFlowRequest->new(); # UpdateFlowRequest | flow update parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $flow = ; # FlowReference | flow path encoded as path param of form 'path=\,category=\'

eval { 
    my $result = $api_instance->updateFlow(body => $body, sandbox => $sandbox, project => $project, flow => $flow);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowApi->updateFlow: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FlowApi()
body =  # UpdateFlowRequest | flow update parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
flow =  # FlowReference | flow path encoded as path param of form 'path=\,category=\'

try: 
    # Update a flow
    api_response = api_instance.update_flow(body, sandbox, project, flow)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowApi->updateFlow: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
flow*
FlowReference
flow path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated flow

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


validateFlow

Validate flow

Perform flow validation and return the validated flow. Flows may be modified during validation.


/flows/{sandbox}/{project}/{flow}/validate

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/flows/{sandbox}/{project}/{flow}/validate?failOnWarnings="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlowApi;

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

public class FlowApiExample {

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


        FlowApi apiInstance = new FlowApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        FlowReference flow = ; // FlowReference | flow path encoded as path param of form 'path=\,category=\'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            Flow result = apiInstance.validateFlow(sandbox, project, flow, failOnWarnings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowApi#validateFlow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FlowApi;

public class FlowApiExample {

    public static void main(String[] args) {
        FlowApi apiInstance = new FlowApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        FlowReference flow = ; // FlowReference | flow path encoded as path param of form 'path=\,category=\'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            Flow result = apiInstance.validateFlow(sandbox, project, flow, failOnWarnings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlowApi#validateFlow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
FlowReference *flow = ; // flow path encoded as path param of form 'path=\,category=\'
Boolean *failOnWarnings = true; // true to fail validation on warnings (optional) (default to false)

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

// Validate flow
[apiInstance validateFlowWith:sandbox
    project:project
    flow:flow
    failOnWarnings:failOnWarnings
              completionHandler: ^(Flow output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.FlowApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var flow = ; // {{FlowReference}} flow path encoded as path param of form 'path=\,category=\'
var opts = { 
  'failOnWarnings': true // {{Boolean}} true to fail validation on warnings
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateFlow(sandbox, project, flow, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new FlowApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var flow = new FlowReference(); // FlowReference | flow path encoded as path param of form 'path=\,category=\'
            var failOnWarnings = true;  // Boolean | true to fail validation on warnings (optional)  (default to false)

            try
            {
                // Validate flow
                Flow result = apiInstance.validateFlow(sandbox, project, flow, failOnWarnings);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlowApi.validateFlow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiFlowApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$flow = ; // FlowReference | flow path encoded as path param of form 'path=\,category=\'
$failOnWarnings = true; // Boolean | true to fail validation on warnings

try {
    $result = $api_instance->validateFlow($sandbox, $project, $flow, $failOnWarnings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FlowApi->validateFlow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FlowApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FlowApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $flow = ; # FlowReference | flow path encoded as path param of form 'path=\,category=\'
my $failOnWarnings = true; # Boolean | true to fail validation on warnings

eval { 
    my $result = $api_instance->validateFlow(sandbox => $sandbox, project => $project, flow => $flow, failOnWarnings => $failOnWarnings);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlowApi->validateFlow: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FlowApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
flow =  # FlowReference | flow path encoded as path param of form 'path=\,category=\'
failOnWarnings = true # Boolean | true to fail validation on warnings (optional) (default to false)

try: 
    # Validate flow
    api_response = api_instance.validate_flow(sandbox, project, flow, failOnWarnings=failOnWarnings)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlowApi->validateFlow: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
flow*
FlowReference
flow path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Query parameters
Name Description
failOnWarnings
Boolean
true to fail validation on warnings

Responses

Status: 200 - Validated flow

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Artifact validation failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


Management

cancelSupportArchive

Cancel in-progress generation of a support archive

Generation of the support archive is canceled. The in-progress identifier is no longer valid after this operation successfully completes.


/support/{identifier}

Usage and SDK Samples

curl -X DELETE\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/support/{identifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagementApi;

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

public class ManagementApiExample {

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


        ManagementApi apiInstance = new ManagementApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | In-progress identifier for support archive generation encoded as path param of form 'identifier=\'
        try {
            apiInstance.cancelSupportArchive(identifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#cancelSupportArchive");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagementApi;

public class ManagementApiExample {

    public static void main(String[] args) {
        ManagementApi apiInstance = new ManagementApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | In-progress identifier for support archive generation encoded as path param of form 'identifier=\'
        try {
            apiInstance.cancelSupportArchive(identifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#cancelSupportArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
ResourceIdentifier *identifier = ; // In-progress identifier for support archive generation encoded as path param of form 'identifier=\'

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

// Cancel in-progress generation of a support archive
[apiInstance cancelSupportArchiveWith:identifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ManagementApi()
var identifier = ; // {{ResourceIdentifier}} In-progress identifier for support archive generation encoded as path param of form 'identifier=\'

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

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

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

            var apiInstance = new ManagementApi();
            var identifier = new ResourceIdentifier(); // ResourceIdentifier | In-progress identifier for support archive generation encoded as path param of form 'identifier=\'

            try
            {
                // Cancel in-progress generation of a support archive
                apiInstance.cancelSupportArchive(identifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.cancelSupportArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiManagementApi();
$identifier = ; // ResourceIdentifier | In-progress identifier for support archive generation encoded as path param of form 'identifier=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ManagementApi->new();
my $identifier = ; # ResourceIdentifier | In-progress identifier for support archive generation encoded as path param of form 'identifier=\'

eval { 
    $api_instance->cancelSupportArchive(identifier => $identifier);
};
if ($@) {
    warn "Exception when calling ManagementApi->cancelSupportArchive: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ManagementApi()
identifier =  # ResourceIdentifier | In-progress identifier for support archive generation encoded as path param of form 'identifier=\'

try: 
    # Cancel in-progress generation of a support archive
    api_instance.cancel_support_archive(identifier)
except ApiException as e:
    print("Exception when calling ManagementApi->cancelSupportArchive: %s\n" % e)

Parameters

Path parameters
Name Description
identifier*
ResourceIdentifier
In-progress identifier for support archive generation encoded as path param of form 'identifier=\<identifier\>'
Required

Responses

Status: 200 - archive generation canceled

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


cancelUsage

Cancel in-progress generation of usage data

Generation of usage data is canceled. The in-progress identifier is no longer valid after this operation successfully completes.


/usage/{identifier}

Usage and SDK Samples

curl -X DELETE\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/usage/{identifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagementApi;

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

public class ManagementApiExample {

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


        ManagementApi apiInstance = new ManagementApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | In-progress identifier for usage data generation encoded as path param of form 'identifier=\'
        try {
            apiInstance.cancelUsage(identifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#cancelUsage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagementApi;

public class ManagementApiExample {

    public static void main(String[] args) {
        ManagementApi apiInstance = new ManagementApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | In-progress identifier for usage data generation encoded as path param of form 'identifier=\'
        try {
            apiInstance.cancelUsage(identifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#cancelUsage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
ResourceIdentifier *identifier = ; // In-progress identifier for usage data generation encoded as path param of form 'identifier=\'

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

// Cancel in-progress generation of usage data
[apiInstance cancelUsageWith:identifier
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ManagementApi()
var identifier = ; // {{ResourceIdentifier}} In-progress identifier for usage data generation encoded as path param of form 'identifier=\'

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

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

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

            var apiInstance = new ManagementApi();
            var identifier = new ResourceIdentifier(); // ResourceIdentifier | In-progress identifier for usage data generation encoded as path param of form 'identifier=\'

            try
            {
                // Cancel in-progress generation of usage data
                apiInstance.cancelUsage(identifier);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.cancelUsage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiManagementApi();
$identifier = ; // ResourceIdentifier | In-progress identifier for usage data generation encoded as path param of form 'identifier=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ManagementApi->new();
my $identifier = ; # ResourceIdentifier | In-progress identifier for usage data generation encoded as path param of form 'identifier=\'

eval { 
    $api_instance->cancelUsage(identifier => $identifier);
};
if ($@) {
    warn "Exception when calling ManagementApi->cancelUsage: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ManagementApi()
identifier =  # ResourceIdentifier | In-progress identifier for usage data generation encoded as path param of form 'identifier=\'

try: 
    # Cancel in-progress generation of usage data
    api_instance.cancel_usage(identifier)
except ApiException as e:
    print("Exception when calling ManagementApi->cancelUsage: %s\n" % e)

Parameters

Path parameters
Name Description
identifier*
ResourceIdentifier
In-progress identifier for usage data generation encoded as path param of form 'identifier=\<identifier\>'
Required

Responses

Status: 200 - usage data generation canceled

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getBuildInfo

Get build information

Get build information. The build information is available to all logged in users.


/support

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/support"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagementApi;

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

public class ManagementApiExample {

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


        ManagementApi apiInstance = new ManagementApi();
        try {
            BuildInformation result = apiInstance.getBuildInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#getBuildInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagementApi;

public class ManagementApiExample {

    public static void main(String[] args) {
        ManagementApi apiInstance = new ManagementApi();
        try {
            BuildInformation result = apiInstance.getBuildInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#getBuildInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];

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

// Get build information
[apiInstance getBuildInfoWithCompletionHandler: 
              ^(BuildInformation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


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

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

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

            var apiInstance = new ManagementApi();

            try
            {
                // Get build information
                BuildInformation result = apiInstance.getBuildInfo();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.getBuildInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

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

eval { 
    my $result = $api_instance->getBuildInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementApi->getBuildInfo: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

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

try: 
    # Get build information
    api_response = api_instance.get_build_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementApi->getBuildInfo: %s\n" % e)

Parameters

Responses

Status: 200 - Build information

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


getCurrentSession

Get the current session

Get the session for the calling user


/sessions/current

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/sessions/current"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagementApi;

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

public class ManagementApiExample {

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


        ManagementApi apiInstance = new ManagementApi();
        try {
            Session result = apiInstance.getCurrentSession();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#getCurrentSession");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagementApi;

public class ManagementApiExample {

    public static void main(String[] args) {
        ManagementApi apiInstance = new ManagementApi();
        try {
            Session result = apiInstance.getCurrentSession();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#getCurrentSession");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];

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

// Get the current session
[apiInstance getCurrentSessionWithCompletionHandler: 
              ^(Session output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


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

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

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

            var apiInstance = new ManagementApi();

            try
            {
                // Get the current session
                Session result = apiInstance.getCurrentSession();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.getCurrentSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

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

eval { 
    my $result = $api_instance->getCurrentSession();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementApi->getCurrentSession: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

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

try: 
    # Get the current session
    api_response = api_instance.get_current_session()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementApi->getCurrentSession: %s\n" % e)

Parameters

Responses

Status: 200 - Current session

Status: 401 - Session token is missing or invalid

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


getSessions

Get sessions

Get all currently active sessions. All active sessions are returned if the login user is in the administration group. If the user is not in the administration group, only session associated with the login user are returned.


/sessions

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/sessions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagementApi;

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

public class ManagementApiExample {

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


        ManagementApi apiInstance = new ManagementApi();
        try {
            array[Session] result = apiInstance.getSessions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#getSessions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagementApi;

public class ManagementApiExample {

    public static void main(String[] args) {
        ManagementApi apiInstance = new ManagementApi();
        try {
            array[Session] result = apiInstance.getSessions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#getSessions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];

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

// Get sessions
[apiInstance getSessionsWithCompletionHandler: 
              ^(array[Session] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


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

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

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

            var apiInstance = new ManagementApi();

            try
            {
                // Get sessions
                array[Session] result = apiInstance.getSessions();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.getSessions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

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

eval { 
    my $result = $api_instance->getSessions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementApi->getSessions: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

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

try: 
    # Get sessions
    api_response = api_instance.get_sessions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementApi->getSessions: %s\n" % e)

Parameters

Responses

Status: 200 - Active sessions

Status: 401 - Session token is missing or invalid

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


getSupportArchive

Get a generated support archive.

The support archive is returned if generation is complete in a 200 response. If generation is not complete a 202 response is returned. The in-progress identifier is no longer valid after this operation returns a 200 response.


/support/{identifier}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/zip,application/json"\
"/artifacts/v2/support/{identifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagementApi;

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

public class ManagementApiExample {

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


        ManagementApi apiInstance = new ManagementApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | In-progress identifier for support archive generation encoded as path param of form 'identifier=\'
        try {
            byte[] result = apiInstance.getSupportArchive(identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#getSupportArchive");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagementApi;

public class ManagementApiExample {

    public static void main(String[] args) {
        ManagementApi apiInstance = new ManagementApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | In-progress identifier for support archive generation encoded as path param of form 'identifier=\'
        try {
            byte[] result = apiInstance.getSupportArchive(identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#getSupportArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
ResourceIdentifier *identifier = ; // In-progress identifier for support archive generation encoded as path param of form 'identifier=\'

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

// Get a generated support archive.
[apiInstance getSupportArchiveWith:identifier
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ManagementApi()
var identifier = ; // {{ResourceIdentifier}} In-progress identifier for support archive generation encoded as path param of form 'identifier=\'

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

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

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

            var apiInstance = new ManagementApi();
            var identifier = new ResourceIdentifier(); // ResourceIdentifier | In-progress identifier for support archive generation encoded as path param of form 'identifier=\'

            try
            {
                // Get a generated support archive.
                byte[] result = apiInstance.getSupportArchive(identifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.getSupportArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiManagementApi();
$identifier = ; // ResourceIdentifier | In-progress identifier for support archive generation encoded as path param of form 'identifier=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ManagementApi->new();
my $identifier = ; # ResourceIdentifier | In-progress identifier for support archive generation encoded as path param of form 'identifier=\'

eval { 
    my $result = $api_instance->getSupportArchive(identifier => $identifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementApi->getSupportArchive: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ManagementApi()
identifier =  # ResourceIdentifier | In-progress identifier for support archive generation encoded as path param of form 'identifier=\'

try: 
    # Get a generated support archive.
    api_response = api_instance.get_support_archive(identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementApi->getSupportArchive: %s\n" % e)

Parameters

Path parameters
Name Description
identifier*
ResourceIdentifier
In-progress identifier for support archive generation encoded as path param of form 'identifier=\<identifier\>'
Required

Responses

Status: 200 - technical support archive

Name Type Format Description
Content-Disposition String

Status: 202 - Operation is in progress. *ProgressNotification* events are periodically sent for the operation that returned *InProgress* until the operation is complete.

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getUsage

Get generated usage data

The generated usage is returned if generation is complete in a 200 response. If generation is not complete a 202 response is returned. The in-progress identifier is no longer valid after this operation returns a 200 response. Usage data is returned either as JSON or CSV depending on request.


/usage/{identifier}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,text/csv"\
"/artifacts/v2/usage/{identifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagementApi;

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

public class ManagementApiExample {

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


        ManagementApi apiInstance = new ManagementApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | In-progress identifier for usage data generation encoded as path param of form 'identifier=\'
        try {
            UsageData result = apiInstance.getUsage(identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#getUsage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagementApi;

public class ManagementApiExample {

    public static void main(String[] args) {
        ManagementApi apiInstance = new ManagementApi();
        ResourceIdentifier identifier = ; // ResourceIdentifier | In-progress identifier for usage data generation encoded as path param of form 'identifier=\'
        try {
            UsageData result = apiInstance.getUsage(identifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#getUsage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
ResourceIdentifier *identifier = ; // In-progress identifier for usage data generation encoded as path param of form 'identifier=\'

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

// Get generated usage data
[apiInstance getUsageWith:identifier
              completionHandler: ^(UsageData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ManagementApi()
var identifier = ; // {{ResourceIdentifier}} In-progress identifier for usage data generation encoded as path param of form 'identifier=\'

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

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

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

            var apiInstance = new ManagementApi();
            var identifier = new ResourceIdentifier(); // ResourceIdentifier | In-progress identifier for usage data generation encoded as path param of form 'identifier=\'

            try
            {
                // Get generated usage data
                UsageData result = apiInstance.getUsage(identifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.getUsage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiManagementApi();
$identifier = ; // ResourceIdentifier | In-progress identifier for usage data generation encoded as path param of form 'identifier=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ManagementApi->new();
my $identifier = ; # ResourceIdentifier | In-progress identifier for usage data generation encoded as path param of form 'identifier=\'

eval { 
    my $result = $api_instance->getUsage(identifier => $identifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementApi->getUsage: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ManagementApi()
identifier =  # ResourceIdentifier | In-progress identifier for usage data generation encoded as path param of form 'identifier=\'

try: 
    # Get generated usage data
    api_response = api_instance.get_usage(identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementApi->getUsage: %s\n" % e)

Parameters

Path parameters
Name Description
identifier*
ResourceIdentifier
In-progress identifier for usage data generation encoded as path param of form 'identifier=\<identifier\>'
Required

Responses

Status: 200 - Usage data

Status: 202 - Operation is in progress. *ProgressNotification* events are periodically sent for the operation that returned *InProgress* until the operation is complete.

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getUserSessions

Get user sessions

Get active user sessions for a specific user. Non-administrator users may only call this for their own sessions, with their own user name. Users in the administrator group may call this for any user's sessions.


/sessions/{user}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/sessions/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagementApi;

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

public class ManagementApiExample {

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


        ManagementApi apiInstance = new ManagementApi();
        Identifier user = ; // Identifier | user name
        try {
            array[Session] result = apiInstance.getUserSessions(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#getUserSessions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagementApi;

public class ManagementApiExample {

    public static void main(String[] args) {
        ManagementApi apiInstance = new ManagementApi();
        Identifier user = ; // Identifier | user name
        try {
            array[Session] result = apiInstance.getUserSessions(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#getUserSessions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
Identifier *user = ; // user name

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

// Get user sessions
[apiInstance getUserSessionsWith:user
              completionHandler: ^(array[Session] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ManagementApi()
var user = ; // {{Identifier}} user name

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

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

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

            var apiInstance = new ManagementApi();
            var user = new Identifier(); // Identifier | user name

            try
            {
                // Get user sessions
                array[Session] result = apiInstance.getUserSessions(user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.getUserSessions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiManagementApi();
$user = ; // Identifier | user name

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ManagementApi->new();
my $user = ; # Identifier | user name

eval { 
    my $result = $api_instance->getUserSessions(user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementApi->getUserSessions: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ManagementApi()
user =  # Identifier | user name

try: 
    # Get user sessions
    api_response = api_instance.get_user_sessions(user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementApi->getUserSessions: %s\n" % e)

Parameters

Path parameters
Name Description
user*
Identifier
user name
Required

Responses

Status: 200 - Active sessions for user

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


message

Send a message

Send a message. The message is sent to all target sessions using a MessageNotification notification. The message can be sent to all active users or a specific user. This operation can only be called by a user in the administration group.


/sessions/message

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/sessions/message"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagementApi;

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

public class ManagementApiExample {

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


        ManagementApi apiInstance = new ManagementApi();
        MessageRequest body = ; // MessageRequest | event parameters
        try {
            apiInstance.message(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#message");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagementApi;

public class ManagementApiExample {

    public static void main(String[] args) {
        ManagementApi apiInstance = new ManagementApi();
        MessageRequest body = ; // MessageRequest | event parameters
        try {
            apiInstance.message(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#message");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
MessageRequest *body = ; // event parameters

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

// Send a message
[apiInstance messageWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ManagementApi()
var body = ; // {{MessageRequest}} event parameters

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

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

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

            var apiInstance = new ManagementApi();
            var body = new MessageRequest(); // MessageRequest | event parameters

            try
            {
                // Send a message
                apiInstance.message(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.message: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiManagementApi();
$body = ; // MessageRequest | event parameters

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ManagementApi->new();
my $body = WWW::SwaggerClient::Object::MessageRequest->new(); # MessageRequest | event parameters

eval { 
    $api_instance->message(body => $body);
};
if ($@) {
    warn "Exception when calling ManagementApi->message: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ManagementApi()
body =  # MessageRequest | event parameters

try: 
    # Send a message
    api_instance.message(body)
except ApiException as e:
    print("Exception when calling ManagementApi->message: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Message sent, or no active sessions, or no active session for user

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


startSupportArchive

Initiate generation of a technical support archive

Start generating a support archive useful for reporting problems. This operation just initiates the work. See GET /support/{identifier} for returning the actual generated archive. The user executing this operation is only returned information for the environments, deployments, and projects for which they have read access. Attempting to generate a support archive for resources they do not have access to will generate an AuthorizationError. *ProgressNotification* events are periodically sent until the support archive generation is complete.


/support

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/support"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagementApi;

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

public class ManagementApiExample {

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


        ManagementApi apiInstance = new ManagementApi();
        StartSupportArchiveRequest body = ; // StartSupportArchiveRequest | Support archive options.

Multiple filtering options are available, including start and end time,
environment name, deploy name, and project.

        try {
            InProgress result = apiInstance.startSupportArchive(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#startSupportArchive");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagementApi;

public class ManagementApiExample {

    public static void main(String[] args) {
        ManagementApi apiInstance = new ManagementApi();
        StartSupportArchiveRequest body = ; // StartSupportArchiveRequest | Support archive options.

Multiple filtering options are available, including start and end time,
environment name, deploy name, and project.

        try {
            InProgress result = apiInstance.startSupportArchive(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#startSupportArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
StartSupportArchiveRequest *body = ; // Support archive options.

Multiple filtering options are available, including start and end time,
environment name, deploy name, and project.
 (optional)

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

// Initiate generation of a technical support archive
[apiInstance startSupportArchiveWith:body
              completionHandler: ^(InProgress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ManagementApi()
var opts = { 
  'body':  // {{StartSupportArchiveRequest}} Support archive options.

Multiple filtering options are available, including start and end time,
environment name, deploy name, and project.

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

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

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

            var apiInstance = new ManagementApi();
            var body = new StartSupportArchiveRequest(); // StartSupportArchiveRequest | Support archive options.

Multiple filtering options are available, including start and end time,
environment name, deploy name, and project.
 (optional) 

            try
            {
                // Initiate generation of a technical support archive
                InProgress result = apiInstance.startSupportArchive(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.startSupportArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiManagementApi();
$body = ; // StartSupportArchiveRequest | Support archive options.

Multiple filtering options are available, including start and end time,
environment name, deploy name, and project.


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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ManagementApi->new();
my $body = WWW::SwaggerClient::Object::StartSupportArchiveRequest->new(); # StartSupportArchiveRequest | Support archive options.

Multiple filtering options are available, including start and end time,
environment name, deploy name, and project.


eval { 
    my $result = $api_instance->startSupportArchive(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementApi->startSupportArchive: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ManagementApi()
body =  # StartSupportArchiveRequest | Support archive options.

Multiple filtering options are available, including start and end time,
environment name, deploy name, and project.
 (optional)

try: 
    # Initiate generation of a technical support archive
    api_response = api_instance.start_support_archive(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementApi->startSupportArchive: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 202 - Operation is in progress. *ProgressNotification* events are periodically sent for the operation that returned *InProgress* until the operation is complete.

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


startUsage

Initiate generation of usage data

Start generating usage data. This operation just initiates the work. See GET /usage/{identifier} for returning the actual generated data. *ProgressNotification* events are periodically sent until the usage data generation is complete. The user executing this operation is only returned usage information for environments for which they have read access. Attempting to generate usage for environments for which they do not have access to will generate an AuthorizationError. By default, a summary report for all environments for which a user has read access is returned. Optionally, this can be filtered by one or more environments. Daily usage per environment is also supported. Environment filtering is supported for both summary and daily usage data. Usage data can be returned as JSON or CSV. Default is CSV.


/usage

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/usage"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagementApi;

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

public class ManagementApiExample {

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


        ManagementApi apiInstance = new ManagementApi();
        StartUsageRequest body = ; // StartUsageRequest | Usage report options
        try {
            InProgress result = apiInstance.startUsage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#startUsage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagementApi;

public class ManagementApiExample {

    public static void main(String[] args) {
        ManagementApi apiInstance = new ManagementApi();
        StartUsageRequest body = ; // StartUsageRequest | Usage report options
        try {
            InProgress result = apiInstance.startUsage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#startUsage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
StartUsageRequest *body = ; // Usage report options (optional)

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

// Initiate generation of usage data
[apiInstance startUsageWith:body
              completionHandler: ^(InProgress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ManagementApi()
var opts = { 
  'body':  // {{StartUsageRequest}} Usage report options
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startUsage(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ManagementApi();
            var body = new StartUsageRequest(); // StartUsageRequest | Usage report options (optional) 

            try
            {
                // Initiate generation of usage data
                InProgress result = apiInstance.startUsage(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.startUsage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiManagementApi();
$body = ; // StartUsageRequest | Usage report options

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ManagementApi->new();
my $body = WWW::SwaggerClient::Object::StartUsageRequest->new(); # StartUsageRequest | Usage report options

eval { 
    my $result = $api_instance->startUsage(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementApi->startUsage: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ManagementApi()
body =  # StartUsageRequest | Usage report options (optional)

try: 
    # Initiate generation of usage data
    api_response = api_instance.start_usage(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementApi->startUsage: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 202 - Operation is in progress. *ProgressNotification* events are periodically sent for the operation that returned *InProgress* until the operation is complete.

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


terminateSession

Terminate user sessions

Terminate all active sessions for user. This operation can only be called by a user in the administration group.


/sessions/{user}

Usage and SDK Samples

curl -X DELETE\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/sessions/{user}?message="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagementApi;

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

public class ManagementApiExample {

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


        ManagementApi apiInstance = new ManagementApi();
        Identifier user = ; // Identifier | user name
        String message = message_example; // String | optional message
        try {
            apiInstance.terminateSession(user, message);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#terminateSession");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagementApi;

public class ManagementApiExample {

    public static void main(String[] args) {
        ManagementApi apiInstance = new ManagementApi();
        Identifier user = ; // Identifier | user name
        String message = message_example; // String | optional message
        try {
            apiInstance.terminateSession(user, message);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementApi#terminateSession");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
Identifier *user = ; // user name
String *message = message_example; // optional message (optional)

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

// Terminate user sessions
[apiInstance terminateSessionWith:user
    message:message
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ManagementApi()
var user = ; // {{Identifier}} user name
var opts = { 
  'message': message_example // {{String}} optional message
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.terminateSession(user, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ManagementApi();
            var user = new Identifier(); // Identifier | user name
            var message = message_example;  // String | optional message (optional) 

            try
            {
                // Terminate user sessions
                apiInstance.terminateSession(user, message);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.terminateSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiManagementApi();
$user = ; // Identifier | user name
$message = message_example; // String | optional message

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ManagementApi->new();
my $user = ; # Identifier | user name
my $message = message_example; # String | optional message

eval { 
    $api_instance->terminateSession(user => $user, message => $message);
};
if ($@) {
    warn "Exception when calling ManagementApi->terminateSession: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ManagementApi()
user =  # Identifier | user name
message = message_example # String | optional message (optional)

try: 
    # Terminate user sessions
    api_instance.terminate_session(user, message=message)
except ApiException as e:
    print("Exception when calling ManagementApi->terminateSession: %s\n" % e)

Parameters

Path parameters
Name Description
user*
Identifier
user name
Required
Query parameters
Name Description
message
String
optional message

Responses

Status: 200 - All active sessions terminated, or no active sessions for user

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


Model

bindModel

Bind input and output schemas with a model

Bind input and output schemas to the model. If the input and output schemas are provided in this call, the model is bound to those schemas, otherwise model introspection is used to attempt to create and bind the input and output schemas. If only one schema is provided, an invalid request 400 error is returned. The updated model without the model content, is returned from this call.


/models/{sandbox}/{project}/{model}/bind

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/models/{sandbox}/{project}/{model}/bind"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ModelApi;

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

public class ModelApiExample {

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


        ModelApi apiInstance = new ModelApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ModelReference model = ; // ModelReference | model configuration path encoded as path param of form 'path=\,category=\'
        BindModelRequest body = ; // BindModelRequest | optional input and output schemas to bind with models
        try {
            Model result = apiInstance.bindModel(sandbox, project, model, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#bindModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModelApi;

public class ModelApiExample {

    public static void main(String[] args) {
        ModelApi apiInstance = new ModelApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ModelReference model = ; // ModelReference | model configuration path encoded as path param of form 'path=\,category=\'
        BindModelRequest body = ; // BindModelRequest | optional input and output schemas to bind with models
        try {
            Model result = apiInstance.bindModel(sandbox, project, model, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#bindModel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
ModelReference *model = ; // model configuration path encoded as path param of form 'path=\,category=\'
BindModelRequest *body = ; // optional input and output schemas to bind with models (optional)

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

// Bind input and output schemas with a model
[apiInstance bindModelWith:sandbox
    project:project
    model:model
    body:body
              completionHandler: ^(Model output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ModelApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var model = ; // {{ModelReference}} model configuration path encoded as path param of form 'path=\,category=\'
var opts = { 
  'body':  // {{BindModelRequest}} optional input and output schemas to bind with models
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.bindModel(sandboxprojectmodel, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ModelApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var model = new ModelReference(); // ModelReference | model configuration path encoded as path param of form 'path=\,category=\'
            var body = new BindModelRequest(); // BindModelRequest | optional input and output schemas to bind with models (optional) 

            try
            {
                // Bind input and output schemas with a model
                Model result = apiInstance.bindModel(sandbox, project, model, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModelApi.bindModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiModelApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$model = ; // ModelReference | model configuration path encoded as path param of form 'path=\,category=\'
$body = ; // BindModelRequest | optional input and output schemas to bind with models

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ModelApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $model = ; # ModelReference | model configuration path encoded as path param of form 'path=\,category=\'
my $body = WWW::SwaggerClient::Object::BindModelRequest->new(); # BindModelRequest | optional input and output schemas to bind with models

eval { 
    my $result = $api_instance->bindModel(sandbox => $sandbox, project => $project, model => $model, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModelApi->bindModel: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ModelApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
model =  # ModelReference | model configuration path encoded as path param of form 'path=\,category=\'
body =  # BindModelRequest | optional input and output schemas to bind with models (optional)

try: 
    # Bind input and output schemas with a model
    api_response = api_instance.bind_model(sandbox, project, model, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelApi->bindModel: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
model*
ModelReference
model configuration path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body

Responses

Status: 200 - Bound model on success

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Binding failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


createModel

Create a new model

Create a new model.


/models/{sandbox}/{project}

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"/artifacts/v2/models/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ModelApi;

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

public class ModelApiExample {

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


        ModelApi apiInstance = new ModelApi();
        RelativePath path = ; // RelativePath | 
        ArtifactTypeReference type = ; // ArtifactTypeReference | 
        ModelCategory category = ; // ModelCategory | 
        byte[] content = content_example; // byte[] | 
        Attributes attributes = ; // Attributes | 
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createModel(path, type, category, content, attributes, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#createModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModelApi;

public class ModelApiExample {

    public static void main(String[] args) {
        ModelApi apiInstance = new ModelApi();
        RelativePath path = ; // RelativePath | 
        ArtifactTypeReference type = ; // ArtifactTypeReference | 
        ModelCategory category = ; // ModelCategory | 
        byte[] content = content_example; // byte[] | 
        Attributes attributes = ; // Attributes | 
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createModel(path, type, category, content, attributes, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#createModel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
RelativePath *path = ; // 
ArtifactTypeReference *type = ; // 
ModelCategory *category = ; // 
byte[] *content = content_example; // 
Attributes *attributes = ; // 
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Create a new model
[apiInstance createModelWith:path
    type:type
    category:category
    content:content
    attributes:attributes
    sandbox:sandbox
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ModelApi()
var path = ; // {{RelativePath}} 
var type = ; // {{ArtifactTypeReference}} 
var category = ; // {{ModelCategory}} 
var content = content_example; // {{byte[]}} 
var attributes = ; // {{Attributes}} 
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ModelApi();
            var path = new RelativePath(); // RelativePath | 
            var type = new ArtifactTypeReference(); // ArtifactTypeReference | 
            var category = new ModelCategory(); // ModelCategory | 
            var content = content_example;  // byte[] | 
            var attributes = new Attributes(); // Attributes | 
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Create a new model
                apiInstance.createModel(path, type, category, content, attributes, sandbox, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModelApi.createModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiModelApi();
$path = ; // RelativePath | 
$type = ; // ArtifactTypeReference | 
$category = ; // ModelCategory | 
$content = content_example; // byte[] | 
$attributes = ; // Attributes | 
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try {
    $api_instance->createModel($path, $type, $category, $content, $attributes, $sandbox, $project);
} catch (Exception $e) {
    echo 'Exception when calling ModelApi->createModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ModelApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ModelApi->new();
my $path = ; # RelativePath | 
my $type = ; # ArtifactTypeReference | 
my $category = ; # ModelCategory | 
my $content = content_example; # byte[] | 
my $attributes = ; # Attributes | 
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    $api_instance->createModel(path => $path, type => $type, category => $category, content => $content, attributes => $attributes, sandbox => $sandbox, project => $project);
};
if ($@) {
    warn "Exception when calling ModelApi->createModel: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ModelApi()
path =  # RelativePath | 
type =  # ArtifactTypeReference | 
category =  # ModelCategory | 
content = content_example # byte[] | 
attributes =  # Attributes | 
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Create a new model
    api_instance.create_model(path, type, category, content, attributes, sandbox, project)
except ApiException as e:
    print("Exception when calling ModelApi->createModel: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Form parameters
Name Description
path*
RelativePath
Required
type*
ArtifactTypeReference
Required
category*
ModelCategory
Required
content*
byte[] (binary)
Required
attributes*
Attributes
Required

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getModels

Get all models in a project

Get all models in a project. The model content is not returned from this call. Use GET /projects/{sandbox}/{project}/artifacts/{reference} to fetch the model content if needed.


/models/{sandbox}/{project}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/models/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ModelApi;

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

public class ModelApiExample {

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


        ModelApi apiInstance = new ModelApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[Model] result = apiInstance.getModels(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#getModels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModelApi;

public class ModelApiExample {

    public static void main(String[] args) {
        ModelApi apiInstance = new ModelApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[Model] result = apiInstance.getModels(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#getModels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Get all models in a project
[apiInstance getModelsWith:sandbox
    project:project
              completionHandler: ^(array[Model] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ModelApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ModelApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Get all models in a project
                array[Model] result = apiInstance.getModels(sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModelApi.getModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiModelApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ModelApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->getModels(sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModelApi->getModels: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ModelApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Get all models in a project
    api_response = api_instance.get_models(sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelApi->getModels: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required

Responses

Status: 200 - Models in project

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


updateModel

Update a model

Update an existing model. The updated model without the model content is returned from this call. Use GET /projects/{sandbox}/{project}/artifacts/{reference} to refetch the model content if needed.


/models/{sandbox}/{project}/{model}

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"/artifacts/v2/models/{sandbox}/{project}/{model}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ModelApi;

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

public class ModelApiExample {

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


        ModelApi apiInstance = new ModelApi();
        ModelCategory category = ; // ModelCategory | 
        byte[] content = content_example; // byte[] | 
        Json configuration = ; // Json | 
        String description = description_example; // String | 
        array[SupportedModelDependency] dependencies = ; // array[SupportedModelDependency] | 
        Attributes attributes = ; // Attributes | 
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ModelReference model = ; // ModelReference | model path encoded as path param of form 'path=\,category=\'
        try {
            Model result = apiInstance.updateModel(category, content, configuration, description, dependencies, attributes, sandbox, project, model);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#updateModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModelApi;

public class ModelApiExample {

    public static void main(String[] args) {
        ModelApi apiInstance = new ModelApi();
        ModelCategory category = ; // ModelCategory | 
        byte[] content = content_example; // byte[] | 
        Json configuration = ; // Json | 
        String description = description_example; // String | 
        array[SupportedModelDependency] dependencies = ; // array[SupportedModelDependency] | 
        Attributes attributes = ; // Attributes | 
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ModelReference model = ; // ModelReference | model path encoded as path param of form 'path=\,category=\'
        try {
            Model result = apiInstance.updateModel(category, content, configuration, description, dependencies, attributes, sandbox, project, model);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#updateModel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
ModelCategory *category = ; // 
byte[] *content = content_example; // 
Json *configuration = ; // 
String *description = description_example; // 
array[SupportedModelDependency] *dependencies = ; // 
Attributes *attributes = ; // 
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
ModelReference *model = ; // model path encoded as path param of form 'path=\,category=\'

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

// Update a model
[apiInstance updateModelWith:category
    content:content
    configuration:configuration
    description:description
    dependencies:dependencies
    attributes:attributes
    sandbox:sandbox
    project:project
    model:model
              completionHandler: ^(Model output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ModelApi()
var category = ; // {{ModelCategory}} 
var content = content_example; // {{byte[]}} 
var configuration = ; // {{Json}} 
var description = description_example; // {{String}} 
var dependencies = ; // {{array[SupportedModelDependency]}} 
var attributes = ; // {{Attributes}} 
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var model = ; // {{ModelReference}} model path encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new ModelApi();
            var category = new ModelCategory(); // ModelCategory | 
            var content = content_example;  // byte[] | 
            var configuration = new Json(); // Json | 
            var description = description_example;  // String | 
            var dependencies = new array[SupportedModelDependency](); // array[SupportedModelDependency] | 
            var attributes = new Attributes(); // Attributes | 
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var model = new ModelReference(); // ModelReference | model path encoded as path param of form 'path=\,category=\'

            try
            {
                // Update a model
                Model result = apiInstance.updateModel(category, content, configuration, description, dependencies, attributes, sandbox, project, model);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModelApi.updateModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiModelApi();
$category = ; // ModelCategory | 
$content = content_example; // byte[] | 
$configuration = ; // Json | 
$description = description_example; // String | 
$dependencies = ; // array[SupportedModelDependency] | 
$attributes = ; // Attributes | 
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$model = ; // ModelReference | model path encoded as path param of form 'path=\,category=\'

try {
    $result = $api_instance->updateModel($category, $content, $configuration, $description, $dependencies, $attributes, $sandbox, $project, $model);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelApi->updateModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ModelApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ModelApi->new();
my $category = ; # ModelCategory | 
my $content = content_example; # byte[] | 
my $configuration = ; # Json | 
my $description = description_example; # String | 
my $dependencies = []; # array[SupportedModelDependency] | 
my $attributes = ; # Attributes | 
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $model = ; # ModelReference | model path encoded as path param of form 'path=\,category=\'

eval { 
    my $result = $api_instance->updateModel(category => $category, content => $content, configuration => $configuration, description => $description, dependencies => $dependencies, attributes => $attributes, sandbox => $sandbox, project => $project, model => $model);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModelApi->updateModel: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ModelApi()
category =  # ModelCategory | 
content = content_example # byte[] | 
configuration =  # Json | 
description = description_example # String | 
dependencies =  # array[SupportedModelDependency] | 
attributes =  # Attributes | 
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
model =  # ModelReference | model path encoded as path param of form 'path=\,category=\'

try: 
    # Update a model
    api_response = api_instance.update_model(category, content, configuration, description, dependencies, attributes, sandbox, project, model)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelApi->updateModel: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
model*
ModelReference
model path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Form parameters
Name Description
category*
ModelCategory
Required
content*
byte[] (binary)
Required
configuration*
Json
Required
description*
String
Required
dependencies*
array[SupportedModelDependency]
Required
attributes*
Attributes
Required

Responses

Status: 200 - updated model

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


validateModel

Validate a model

Perform model validation and return the validated model. Models may be modified during validation. The model content is not returned from this call.


/models/{sandbox}/{project}/{model}/validate

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/models/{sandbox}/{project}/{model}/validate?failOnWarnings="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ModelApi;

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

public class ModelApiExample {

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


        ModelApi apiInstance = new ModelApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ModelReference model = ; // ModelReference | model path encoded as path param of form 'path=\,category=\'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            Model result = apiInstance.validateModel(sandbox, project, model, failOnWarnings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#validateModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ModelApi;

public class ModelApiExample {

    public static void main(String[] args) {
        ModelApi apiInstance = new ModelApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ModelReference model = ; // ModelReference | model path encoded as path param of form 'path=\,category=\'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            Model result = apiInstance.validateModel(sandbox, project, model, failOnWarnings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ModelApi#validateModel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
ModelReference *model = ; // model path encoded as path param of form 'path=\,category=\'
Boolean *failOnWarnings = true; // true to fail validation on warnings (optional) (default to false)

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

// Validate a model
[apiInstance validateModelWith:sandbox
    project:project
    model:model
    failOnWarnings:failOnWarnings
              completionHandler: ^(Model output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ModelApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var model = ; // {{ModelReference}} model path encoded as path param of form 'path=\,category=\'
var opts = { 
  'failOnWarnings': true // {{Boolean}} true to fail validation on warnings
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateModel(sandbox, project, model, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ModelApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var model = new ModelReference(); // ModelReference | model path encoded as path param of form 'path=\,category=\'
            var failOnWarnings = true;  // Boolean | true to fail validation on warnings (optional)  (default to false)

            try
            {
                // Validate a model
                Model result = apiInstance.validateModel(sandbox, project, model, failOnWarnings);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ModelApi.validateModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiModelApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$model = ; // ModelReference | model path encoded as path param of form 'path=\,category=\'
$failOnWarnings = true; // Boolean | true to fail validation on warnings

try {
    $result = $api_instance->validateModel($sandbox, $project, $model, $failOnWarnings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModelApi->validateModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ModelApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ModelApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $model = ; # ModelReference | model path encoded as path param of form 'path=\,category=\'
my $failOnWarnings = true; # Boolean | true to fail validation on warnings

eval { 
    my $result = $api_instance->validateModel(sandbox => $sandbox, project => $project, model => $model, failOnWarnings => $failOnWarnings);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ModelApi->validateModel: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ModelApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
model =  # ModelReference | model path encoded as path param of form 'path=\,category=\'
failOnWarnings = true # Boolean | true to fail validation on warnings (optional) (default to false)

try: 
    # Validate a model
    api_response = api_instance.validate_model(sandbox, project, model, failOnWarnings=failOnWarnings)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ModelApi->validateModel: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
model*
ModelReference
model path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Query parameters
Name Description
failOnWarnings
Boolean
true to fail validation on warnings

Responses

Status: 200 - Validated model

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Artifact validation failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


Notification

notifications

Event notification stream

This is a Server-Sent-Event (SSE) notification stream. Notifications will be sent for all subscribed event types, which by default is all event types.


/notifications

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/event-stream,application/json"\
"/artifacts/v2/notifications"
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();

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


        NotificationApi apiInstance = new NotificationApi();
        try {
            Object result = apiInstance.notifications();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#notifications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotificationApi;

public class NotificationApiExample {

    public static void main(String[] args) {
        NotificationApi apiInstance = new NotificationApi();
        try {
            Object result = apiInstance.notifications();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#notifications");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];

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

// Event notification stream
[apiInstance notificationsWithCompletionHandler: 
              ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


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

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

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

            var apiInstance = new NotificationApi();

            try
            {
                // Event notification stream
                Object result = apiInstance.notifications();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotificationApi.notifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

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

eval { 
    my $result = $api_instance->notifications();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotificationApi->notifications: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

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

try: 
    # Event notification stream
    api_response = api_instance.notifications()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationApi->notifications: %s\n" % e)

Parameters

Responses

Status: 200 - SSE notification stream

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


raise

Raise an event notification

Raise an event notification for event type. Event notifications are targeted at a specific user if the username property is specified, otherwise they are broadcast to all currently active sessions


/notifications/{event}

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/notifications/{event}"
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();

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


        NotificationApi apiInstance = new NotificationApi();
        RaiseRequest body = ; // RaiseRequest | event parameters
        EventType event = ; // EventType | event type
        try {
            apiInstance.raise(body, event);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#raise");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotificationApi;

public class NotificationApiExample {

    public static void main(String[] args) {
        NotificationApi apiInstance = new NotificationApi();
        RaiseRequest body = ; // RaiseRequest | event parameters
        EventType event = ; // EventType | event type
        try {
            apiInstance.raise(body, event);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#raise");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
RaiseRequest *body = ; // event parameters
EventType *event = ; // event type

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

// Raise an event notification
[apiInstance raiseWith:body
    event:event
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.NotificationApi()
var body = ; // {{RaiseRequest}} event parameters
var event = ; // {{EventType}} event type

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

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

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

            var apiInstance = new NotificationApi();
            var body = new RaiseRequest(); // RaiseRequest | event parameters
            var event = new EventType(); // EventType | event type

            try
            {
                // Raise an event notification
                apiInstance.raise(body, event);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotificationApi.raise: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiNotificationApi();
$body = ; // RaiseRequest | event parameters
$event = ; // EventType | event type

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotificationApi->new();
my $body = WWW::SwaggerClient::Object::RaiseRequest->new(); # RaiseRequest | event parameters
my $event = ; # EventType | event type

eval { 
    $api_instance->raise(body => $body, event => $event);
};
if ($@) {
    warn "Exception when calling NotificationApi->raise: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.NotificationApi()
body =  # RaiseRequest | event parameters
event =  # EventType | event type

try: 
    # Raise an event notification
    api_instance.raise(body, event)
except ApiException as e:
    print("Exception when calling NotificationApi->raise: %s\n" % e)

Parameters

Path parameters
Name Description
event*
EventType
event type
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successfully raised event

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


subscribe

Subscribe to event notifications

Subscribe to notifications for event type. If already subscribed to this event this API quietly does nothing


/notifications/{event}

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/notifications/{event}"
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();

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


        NotificationApi apiInstance = new NotificationApi();
        EventType event = ; // EventType | event type
        try {
            apiInstance.subscribe(event);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#subscribe");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotificationApi;

public class NotificationApiExample {

    public static void main(String[] args) {
        NotificationApi apiInstance = new NotificationApi();
        EventType event = ; // EventType | event type
        try {
            apiInstance.subscribe(event);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#subscribe");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
EventType *event = ; // event type

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

// Subscribe to event notifications
[apiInstance subscribeWith:event
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.NotificationApi()
var event = ; // {{EventType}} event type

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

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

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

            var apiInstance = new NotificationApi();
            var event = new EventType(); // EventType | event type

            try
            {
                // Subscribe to event notifications
                apiInstance.subscribe(event);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotificationApi.subscribe: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiNotificationApi();
$event = ; // EventType | event type

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotificationApi->new();
my $event = ; # EventType | event type

eval { 
    $api_instance->subscribe(event => $event);
};
if ($@) {
    warn "Exception when calling NotificationApi->subscribe: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.NotificationApi()
event =  # EventType | event type

try: 
    # Subscribe to event notifications
    api_instance.subscribe(event)
except ApiException as e:
    print("Exception when calling NotificationApi->subscribe: %s\n" % e)

Parameters

Path parameters
Name Description
event*
EventType
event type
Required

Responses

Status: 200 - Successfully subscribed to event

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


subscriptions

Determine if a subscription exists for event type

Determine if a subscription exists for event type


/notifications/{event}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/notifications/{event}"
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();

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


        NotificationApi apiInstance = new NotificationApi();
        EventType event = ; // EventType | event type
        try {
            apiInstance.subscriptions(event);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#subscriptions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotificationApi;

public class NotificationApiExample {

    public static void main(String[] args) {
        NotificationApi apiInstance = new NotificationApi();
        EventType event = ; // EventType | event type
        try {
            apiInstance.subscriptions(event);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#subscriptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
EventType *event = ; // event type

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

// Determine if a subscription exists for event type
[apiInstance subscriptionsWith:event
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.NotificationApi()
var event = ; // {{EventType}} event type

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

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

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

            var apiInstance = new NotificationApi();
            var event = new EventType(); // EventType | event type

            try
            {
                // Determine if a subscription exists for event type
                apiInstance.subscriptions(event);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotificationApi.subscriptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiNotificationApi();
$event = ; // EventType | event type

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotificationApi->new();
my $event = ; # EventType | event type

eval { 
    $api_instance->subscriptions(event => $event);
};
if ($@) {
    warn "Exception when calling NotificationApi->subscriptions: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.NotificationApi()
event =  # EventType | event type

try: 
    # Determine if a subscription exists for event type
    api_instance.subscriptions(event)
except ApiException as e:
    print("Exception when calling NotificationApi->subscriptions: %s\n" % e)

Parameters

Path parameters
Name Description
event*
EventType
event type
Required

Responses

Status: 200 - Subscription exists

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


unsubscribe

Unsubscribe to event notifications

Unsubscribe from event notifications for event type. If already unsubscribed to this event this API quietly does nothing


/notifications/{event}

Usage and SDK Samples

curl -X DELETE\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/notifications/{event}"
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();

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


        NotificationApi apiInstance = new NotificationApi();
        EventType event = ; // EventType | event type
        try {
            apiInstance.unsubscribe(event);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#unsubscribe");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotificationApi;

public class NotificationApiExample {

    public static void main(String[] args) {
        NotificationApi apiInstance = new NotificationApi();
        EventType event = ; // EventType | event type
        try {
            apiInstance.unsubscribe(event);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#unsubscribe");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
EventType *event = ; // event type

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

// Unsubscribe to event notifications
[apiInstance unsubscribeWith:event
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.NotificationApi()
var event = ; // {{EventType}} event type

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

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

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

            var apiInstance = new NotificationApi();
            var event = new EventType(); // EventType | event type

            try
            {
                // Unsubscribe to event notifications
                apiInstance.unsubscribe(event);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotificationApi.unsubscribe: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiNotificationApi();
$event = ; // EventType | event type

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::NotificationApi->new();
my $event = ; # EventType | event type

eval { 
    $api_instance->unsubscribe(event => $event);
};
if ($@) {
    warn "Exception when calling NotificationApi->unsubscribe: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.NotificationApi()
event =  # EventType | event type

try: 
    # Unsubscribe to event notifications
    api_instance.unsubscribe(event)
except ApiException as e:
    print("Exception when calling NotificationApi->unsubscribe: %s\n" % e)

Parameters

Path parameters
Name Description
event*
EventType
event type
Required

Responses

Status: 200 - Successfully unsubscribed from event

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


Pipeline

bindPipelineToFlows

Bind flows with a pipeline

Bind flows to a pipeline, if the pipeline was previously bound to flows, those bindings are cleared and it is rebound to the new flows. If the request body is an empty list, the previous bindings are cleared.


/pipelines/{sandbox}/{project}/{pipeline}/flows

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/pipelines/{sandbox}/{project}/{pipeline}/flows"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PipelineApi;

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

public class PipelineApiExample {

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


        PipelineApi apiInstance = new PipelineApi();
        array[BoundFlow] body = ; // array[BoundFlow] | flows to bind with pipeline
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        PipelineReference pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
        try {
            Pipeline result = apiInstance.bindPipelineToFlows(body, sandbox, project, pipeline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#bindPipelineToFlows");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PipelineApi;

public class PipelineApiExample {

    public static void main(String[] args) {
        PipelineApi apiInstance = new PipelineApi();
        array[BoundFlow] body = ; // array[BoundFlow] | flows to bind with pipeline
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        PipelineReference pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
        try {
            Pipeline result = apiInstance.bindPipelineToFlows(body, sandbox, project, pipeline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#bindPipelineToFlows");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
array[BoundFlow] *body = ; // flows to bind with pipeline
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
PipelineReference *pipeline = ; // pipeline path encoded as path param of form 'path=\,category=\'

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

// Bind flows with a pipeline
[apiInstance bindPipelineToFlowsWith:body
    sandbox:sandbox
    project:project
    pipeline:pipeline
              completionHandler: ^(Pipeline output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.PipelineApi()
var body = ; // {{array[BoundFlow]}} flows to bind with pipeline
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var pipeline = ; // {{PipelineReference}} pipeline path encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new PipelineApi();
            var body = new array[BoundFlow](); // array[BoundFlow] | flows to bind with pipeline
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var pipeline = new PipelineReference(); // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

            try
            {
                // Bind flows with a pipeline
                Pipeline result = apiInstance.bindPipelineToFlows(body, sandbox, project, pipeline);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PipelineApi.bindPipelineToFlows: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPipelineApi();
$body = ; // array[BoundFlow] | flows to bind with pipeline
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PipelineApi->new();
my $body = [WWW::SwaggerClient::Object::array[BoundFlow]->new()]; # array[BoundFlow] | flows to bind with pipeline
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $pipeline = ; # PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

eval { 
    my $result = $api_instance->bindPipelineToFlows(body => $body, sandbox => $sandbox, project => $project, pipeline => $pipeline);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelineApi->bindPipelineToFlows: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PipelineApi()
body =  # array[BoundFlow] | flows to bind with pipeline
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
pipeline =  # PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

try: 
    # Bind flows with a pipeline
    api_response = api_instance.bind_pipeline_to_flows(body, sandbox, project, pipeline)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelineApi->bindPipelineToFlows: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
pipeline*
PipelineReference
pipeline path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated pipeline on success

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Binding failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


bindPipelineToRest

Bind REST service with a pipeline

Bind pipeline as a REST service. If pipeline was previously bound to data channels, that binding is cleared and it is rebound as a REST service.


/pipelines/{sandbox}/{project}/{pipeline}/rest

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/pipelines/{sandbox}/{project}/{pipeline}/rest"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PipelineApi;

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

public class PipelineApiExample {

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


        PipelineApi apiInstance = new PipelineApi();
        BindPipelineToRestRequest body = ; // BindPipelineToRestRequest | REST configuration to bind with pipeline
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        PipelineReference pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
        try {
            Pipeline result = apiInstance.bindPipelineToRest(body, sandbox, project, pipeline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#bindPipelineToRest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PipelineApi;

public class PipelineApiExample {

    public static void main(String[] args) {
        PipelineApi apiInstance = new PipelineApi();
        BindPipelineToRestRequest body = ; // BindPipelineToRestRequest | REST configuration to bind with pipeline
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        PipelineReference pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
        try {
            Pipeline result = apiInstance.bindPipelineToRest(body, sandbox, project, pipeline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#bindPipelineToRest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
BindPipelineToRestRequest *body = ; // REST configuration to bind with pipeline
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
PipelineReference *pipeline = ; // pipeline path encoded as path param of form 'path=\,category=\'

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

// Bind REST service with a pipeline
[apiInstance bindPipelineToRestWith:body
    sandbox:sandbox
    project:project
    pipeline:pipeline
              completionHandler: ^(Pipeline output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.PipelineApi()
var body = ; // {{BindPipelineToRestRequest}} REST configuration to bind with pipeline
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var pipeline = ; // {{PipelineReference}} pipeline path encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new PipelineApi();
            var body = new BindPipelineToRestRequest(); // BindPipelineToRestRequest | REST configuration to bind with pipeline
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var pipeline = new PipelineReference(); // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

            try
            {
                // Bind REST service with a pipeline
                Pipeline result = apiInstance.bindPipelineToRest(body, sandbox, project, pipeline);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PipelineApi.bindPipelineToRest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPipelineApi();
$body = ; // BindPipelineToRestRequest | REST configuration to bind with pipeline
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PipelineApi->new();
my $body = WWW::SwaggerClient::Object::BindPipelineToRestRequest->new(); # BindPipelineToRestRequest | REST configuration to bind with pipeline
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $pipeline = ; # PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

eval { 
    my $result = $api_instance->bindPipelineToRest(body => $body, sandbox => $sandbox, project => $project, pipeline => $pipeline);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelineApi->bindPipelineToRest: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PipelineApi()
body =  # BindPipelineToRestRequest | REST configuration to bind with pipeline
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
pipeline =  # PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

try: 
    # Bind REST service with a pipeline
    api_response = api_instance.bind_pipeline_to_rest(body, sandbox, project, pipeline)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelineApi->bindPipelineToRest: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
pipeline*
PipelineReference
pipeline path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated pipeline on success

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Binding failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


bindPipelineToSinks

Bind one or more sink data channels with a pipeline

Bind sink data channels with a pipeline. If pipeline was previously bound as a REST service, that binding is cleared and it is rebound to the sink data channels. If the pipeline was previously bound to sink data channels, those bindings are cleared and it is rebound to the new sink data channels. If the request body is an empty list, the previous bindings are cleared.


/pipelines/{sandbox}/{project}/{pipeline}/sinks

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/pipelines/{sandbox}/{project}/{pipeline}/sinks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PipelineApi;

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

public class PipelineApiExample {

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


        PipelineApi apiInstance = new PipelineApi();
        array[FlowToSinkBinding] body = ; // array[FlowToSinkBinding] | sink data channels to bind to pipeline
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        PipelineReference pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
        try {
            Pipeline result = apiInstance.bindPipelineToSinks(body, sandbox, project, pipeline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#bindPipelineToSinks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PipelineApi;

public class PipelineApiExample {

    public static void main(String[] args) {
        PipelineApi apiInstance = new PipelineApi();
        array[FlowToSinkBinding] body = ; // array[FlowToSinkBinding] | sink data channels to bind to pipeline
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        PipelineReference pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
        try {
            Pipeline result = apiInstance.bindPipelineToSinks(body, sandbox, project, pipeline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#bindPipelineToSinks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
array[FlowToSinkBinding] *body = ; // sink data channels to bind to pipeline
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
PipelineReference *pipeline = ; // pipeline path encoded as path param of form 'path=\,category=\'

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

// Bind one or more sink data channels with a pipeline
[apiInstance bindPipelineToSinksWith:body
    sandbox:sandbox
    project:project
    pipeline:pipeline
              completionHandler: ^(Pipeline output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.PipelineApi()
var body = ; // {{array[FlowToSinkBinding]}} sink data channels to bind to pipeline
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var pipeline = ; // {{PipelineReference}} pipeline path encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new PipelineApi();
            var body = new array[FlowToSinkBinding](); // array[FlowToSinkBinding] | sink data channels to bind to pipeline
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var pipeline = new PipelineReference(); // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

            try
            {
                // Bind one or more sink data channels with a pipeline
                Pipeline result = apiInstance.bindPipelineToSinks(body, sandbox, project, pipeline);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PipelineApi.bindPipelineToSinks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPipelineApi();
$body = ; // array[FlowToSinkBinding] | sink data channels to bind to pipeline
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PipelineApi->new();
my $body = [WWW::SwaggerClient::Object::array[FlowToSinkBinding]->new()]; # array[FlowToSinkBinding] | sink data channels to bind to pipeline
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $pipeline = ; # PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

eval { 
    my $result = $api_instance->bindPipelineToSinks(body => $body, sandbox => $sandbox, project => $project, pipeline => $pipeline);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelineApi->bindPipelineToSinks: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PipelineApi()
body =  # array[FlowToSinkBinding] | sink data channels to bind to pipeline
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
pipeline =  # PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

try: 
    # Bind one or more sink data channels with a pipeline
    api_response = api_instance.bind_pipeline_to_sinks(body, sandbox, project, pipeline)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelineApi->bindPipelineToSinks: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
pipeline*
PipelineReference
pipeline path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated pipeline on success

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Binding failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


bindPipelineToSource

Bind a source data channel with a pipeline

Bind a source data channel to a pipeline. If pipeline was previously bound as a REST service, that binding is cleared and it is rebound to the source data channel.


/pipelines/{sandbox}/{project}/{pipeline}/source

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/pipelines/{sandbox}/{project}/{pipeline}/source"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PipelineApi;

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

public class PipelineApiExample {

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


        PipelineApi apiInstance = new PipelineApi();
        DataChannelTarget body = ; // DataChannelTarget | a source data channel to bind with pipeline
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        PipelineReference pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
        try {
            Pipeline result = apiInstance.bindPipelineToSource(body, sandbox, project, pipeline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#bindPipelineToSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PipelineApi;

public class PipelineApiExample {

    public static void main(String[] args) {
        PipelineApi apiInstance = new PipelineApi();
        DataChannelTarget body = ; // DataChannelTarget | a source data channel to bind with pipeline
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        PipelineReference pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
        try {
            Pipeline result = apiInstance.bindPipelineToSource(body, sandbox, project, pipeline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#bindPipelineToSource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
DataChannelTarget *body = ; // a source data channel to bind with pipeline
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
PipelineReference *pipeline = ; // pipeline path encoded as path param of form 'path=\,category=\'

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

// Bind a source data channel with a pipeline
[apiInstance bindPipelineToSourceWith:body
    sandbox:sandbox
    project:project
    pipeline:pipeline
              completionHandler: ^(Pipeline output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.PipelineApi()
var body = ; // {{DataChannelTarget}} a source data channel to bind with pipeline
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var pipeline = ; // {{PipelineReference}} pipeline path encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new PipelineApi();
            var body = new DataChannelTarget(); // DataChannelTarget | a source data channel to bind with pipeline
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var pipeline = new PipelineReference(); // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

            try
            {
                // Bind a source data channel with a pipeline
                Pipeline result = apiInstance.bindPipelineToSource(body, sandbox, project, pipeline);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PipelineApi.bindPipelineToSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPipelineApi();
$body = ; // DataChannelTarget | a source data channel to bind with pipeline
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PipelineApi->new();
my $body = WWW::SwaggerClient::Object::DataChannelTarget->new(); # DataChannelTarget | a source data channel to bind with pipeline
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $pipeline = ; # PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

eval { 
    my $result = $api_instance->bindPipelineToSource(body => $body, sandbox => $sandbox, project => $project, pipeline => $pipeline);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelineApi->bindPipelineToSource: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PipelineApi()
body =  # DataChannelTarget | a source data channel to bind with pipeline
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
pipeline =  # PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

try: 
    # Bind a source data channel with a pipeline
    api_response = api_instance.bind_pipeline_to_source(body, sandbox, project, pipeline)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelineApi->bindPipelineToSource: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
pipeline*
PipelineReference
pipeline path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated pipeline on success

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Binding failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


createPipeline

Create a new pipeline

Create a new pipeline.


/pipelines/{sandbox}/{project}

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/pipelines/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PipelineApi;

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

public class PipelineApiExample {

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


        PipelineApi apiInstance = new PipelineApi();
        CreatePipelineRequest body = ; // CreatePipelineRequest | pipeline creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createPipeline(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#createPipeline");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PipelineApi;

public class PipelineApiExample {

    public static void main(String[] args) {
        PipelineApi apiInstance = new PipelineApi();
        CreatePipelineRequest body = ; // CreatePipelineRequest | pipeline creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createPipeline(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#createPipeline");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
CreatePipelineRequest *body = ; // pipeline creation parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Create a new pipeline
[apiInstance createPipelineWith:body
    sandbox:sandbox
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.PipelineApi()
var body = ; // {{CreatePipelineRequest}} pipeline creation parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new PipelineApi();
            var body = new CreatePipelineRequest(); // CreatePipelineRequest | pipeline creation parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Create a new pipeline
                apiInstance.createPipeline(body, sandbox, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PipelineApi.createPipeline: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPipelineApi();
$body = ; // CreatePipelineRequest | pipeline creation parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try {
    $api_instance->createPipeline($body, $sandbox, $project);
} catch (Exception $e) {
    echo 'Exception when calling PipelineApi->createPipeline: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PipelineApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PipelineApi->new();
my $body = WWW::SwaggerClient::Object::CreatePipelineRequest->new(); # CreatePipelineRequest | pipeline creation parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    $api_instance->createPipeline(body => $body, sandbox => $sandbox, project => $project);
};
if ($@) {
    warn "Exception when calling PipelineApi->createPipeline: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PipelineApi()
body =  # CreatePipelineRequest | pipeline creation parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Create a new pipeline
    api_instance.create_pipeline(body, sandbox, project)
except ApiException as e:
    print("Exception when calling PipelineApi->createPipeline: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getPipelines

Get all pipelines in a project

Get all pipelines in a project.


/pipelines/{sandbox}/{project}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/pipelines/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PipelineApi;

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

public class PipelineApiExample {

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


        PipelineApi apiInstance = new PipelineApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[Pipeline] result = apiInstance.getPipelines(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#getPipelines");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PipelineApi;

public class PipelineApiExample {

    public static void main(String[] args) {
        PipelineApi apiInstance = new PipelineApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[Pipeline] result = apiInstance.getPipelines(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#getPipelines");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Get all pipelines in a project
[apiInstance getPipelinesWith:sandbox
    project:project
              completionHandler: ^(array[Pipeline] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.PipelineApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new PipelineApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Get all pipelines in a project
                array[Pipeline] result = apiInstance.getPipelines(sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PipelineApi.getPipelines: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPipelineApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PipelineApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->getPipelines(sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelineApi->getPipelines: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PipelineApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Get all pipelines in a project
    api_response = api_instance.get_pipelines(sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelineApi->getPipelines: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required

Responses

Status: 200 - Pipelines in project

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


updatePipeline

Update a pipeline

Update a pipeline description


/pipelines/{sandbox}/{project}/{pipeline}

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/pipelines/{sandbox}/{project}/{pipeline}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PipelineApi;

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

public class PipelineApiExample {

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


        PipelineApi apiInstance = new PipelineApi();
        UpdatePipelineRequest body = ; // UpdatePipelineRequest | pipeline update parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        PipelineReference pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
        try {
            Pipeline result = apiInstance.updatePipeline(body, sandbox, project, pipeline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#updatePipeline");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PipelineApi;

public class PipelineApiExample {

    public static void main(String[] args) {
        PipelineApi apiInstance = new PipelineApi();
        UpdatePipelineRequest body = ; // UpdatePipelineRequest | pipeline update parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        PipelineReference pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
        try {
            Pipeline result = apiInstance.updatePipeline(body, sandbox, project, pipeline);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#updatePipeline");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
UpdatePipelineRequest *body = ; // pipeline update parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
PipelineReference *pipeline = ; // pipeline path encoded as path param of form 'path=\,category=\'

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

// Update a pipeline
[apiInstance updatePipelineWith:body
    sandbox:sandbox
    project:project
    pipeline:pipeline
              completionHandler: ^(Pipeline output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.PipelineApi()
var body = ; // {{UpdatePipelineRequest}} pipeline update parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var pipeline = ; // {{PipelineReference}} pipeline path encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new PipelineApi();
            var body = new UpdatePipelineRequest(); // UpdatePipelineRequest | pipeline update parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var pipeline = new PipelineReference(); // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

            try
            {
                // Update a pipeline
                Pipeline result = apiInstance.updatePipeline(body, sandbox, project, pipeline);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PipelineApi.updatePipeline: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPipelineApi();
$body = ; // UpdatePipelineRequest | pipeline update parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PipelineApi->new();
my $body = WWW::SwaggerClient::Object::UpdatePipelineRequest->new(); # UpdatePipelineRequest | pipeline update parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $pipeline = ; # PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

eval { 
    my $result = $api_instance->updatePipeline(body => $body, sandbox => $sandbox, project => $project, pipeline => $pipeline);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelineApi->updatePipeline: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PipelineApi()
body =  # UpdatePipelineRequest | pipeline update parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
pipeline =  # PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'

try: 
    # Update a pipeline
    api_response = api_instance.update_pipeline(body, sandbox, project, pipeline)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelineApi->updatePipeline: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
pipeline*
PipelineReference
pipeline path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated pipeline

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


validatePipeline

Validate a pipeline

Perform pipeline validation and return the validated pipeline. Pipelines may be modified during validation.


/pipelines/{sandbox}/{project}/{pipeline}/validate

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/pipelines/{sandbox}/{project}/{pipeline}/validate?failOnWarnings="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PipelineApi;

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

public class PipelineApiExample {

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


        PipelineApi apiInstance = new PipelineApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        PipelineReference pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            Pipeline result = apiInstance.validatePipeline(sandbox, project, pipeline, failOnWarnings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#validatePipeline");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PipelineApi;

public class PipelineApiExample {

    public static void main(String[] args) {
        PipelineApi apiInstance = new PipelineApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        PipelineReference pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            Pipeline result = apiInstance.validatePipeline(sandbox, project, pipeline, failOnWarnings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PipelineApi#validatePipeline");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
PipelineReference *pipeline = ; // pipeline path encoded as path param of form 'path=\,category=\'
Boolean *failOnWarnings = true; // true to fail validation on warnings (optional) (default to false)

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

// Validate a pipeline
[apiInstance validatePipelineWith:sandbox
    project:project
    pipeline:pipeline
    failOnWarnings:failOnWarnings
              completionHandler: ^(Pipeline output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.PipelineApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var pipeline = ; // {{PipelineReference}} pipeline path encoded as path param of form 'path=\,category=\'
var opts = { 
  'failOnWarnings': true // {{Boolean}} true to fail validation on warnings
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validatePipeline(sandbox, project, pipeline, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new PipelineApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var pipeline = new PipelineReference(); // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
            var failOnWarnings = true;  // Boolean | true to fail validation on warnings (optional)  (default to false)

            try
            {
                // Validate a pipeline
                Pipeline result = apiInstance.validatePipeline(sandbox, project, pipeline, failOnWarnings);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PipelineApi.validatePipeline: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPipelineApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$pipeline = ; // PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
$failOnWarnings = true; // Boolean | true to fail validation on warnings

try {
    $result = $api_instance->validatePipeline($sandbox, $project, $pipeline, $failOnWarnings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelineApi->validatePipeline: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PipelineApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PipelineApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $pipeline = ; # PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
my $failOnWarnings = true; # Boolean | true to fail validation on warnings

eval { 
    my $result = $api_instance->validatePipeline(sandbox => $sandbox, project => $project, pipeline => $pipeline, failOnWarnings => $failOnWarnings);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PipelineApi->validatePipeline: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PipelineApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
pipeline =  # PipelineReference | pipeline path encoded as path param of form 'path=\,category=\'
failOnWarnings = true # Boolean | true to fail validation on warnings (optional) (default to false)

try: 
    # Validate a pipeline
    api_response = api_instance.validate_pipeline(sandbox, project, pipeline, failOnWarnings=failOnWarnings)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelineApi->validatePipeline: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
pipeline*
PipelineReference
pipeline path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Query parameters
Name Description
failOnWarnings
Boolean
true to fail validation on warnings

Responses

Status: 200 - Validated pipeline

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Artifact validation failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


Project

approveProject

Approve project for deployment to target cloud resource(s)

Approve a project for deployment into one or more target cloud resources. The project was modified on successful approval. The current user must be in a group with approval permission for all cloud resources(s).


/projects/{sandbox}/{project}/approve

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/approve"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        array[ResourceReference] body = ; // array[ResourceReference] | Approve this project for deployment to these cloud resources.

Multiple cloud resources approvals are required if a project contains
data channels that are exposed to cloud resources that are not the
target of the deployment.

If the project has dependent projects, they must be approved first for 
the cloud resources.  If they are not approved, the approval will fail
for this project.

Any previous approvals are cleared by passing in an empty array of cloud resources.

        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.approveProject(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#approveProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        array[ResourceReference] body = ; // array[ResourceReference] | Approve this project for deployment to these cloud resources.

Multiple cloud resources approvals are required if a project contains
data channels that are exposed to cloud resources that are not the
target of the deployment.

If the project has dependent projects, they must be approved first for 
the cloud resources.  If they are not approved, the approval will fail
for this project.

Any previous approvals are cleared by passing in an empty array of cloud resources.

        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.approveProject(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#approveProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
array[ResourceReference] *body = ; // Approve this project for deployment to these cloud resources.

Multiple cloud resources approvals are required if a project contains
data channels that are exposed to cloud resources that are not the
target of the deployment.

If the project has dependent projects, they must be approved first for 
the cloud resources.  If they are not approved, the approval will fail
for this project.

Any previous approvals are cleared by passing in an empty array of cloud resources.

SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Approve project for deployment to target cloud resource(s)
[apiInstance approveProjectWith:body
    sandbox:sandbox
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var body = ; // {{array[ResourceReference]}} Approve this project for deployment to these cloud resources.

Multiple cloud resources approvals are required if a project contains
data channels that are exposed to cloud resources that are not the
target of the deployment.

If the project has dependent projects, they must be approved first for 
the cloud resources.  If they are not approved, the approval will fail
for this project.

Any previous approvals are cleared by passing in an empty array of cloud resources.

var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ProjectApi();
            var body = new array[ResourceReference](); // array[ResourceReference] | Approve this project for deployment to these cloud resources.

Multiple cloud resources approvals are required if a project contains
data channels that are exposed to cloud resources that are not the
target of the deployment.

If the project has dependent projects, they must be approved first for 
the cloud resources.  If they are not approved, the approval will fail
for this project.

Any previous approvals are cleared by passing in an empty array of cloud resources.

            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Approve project for deployment to target cloud resource(s)
                apiInstance.approveProject(body, sandbox, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.approveProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$body = ; // array[ResourceReference] | Approve this project for deployment to these cloud resources.

Multiple cloud resources approvals are required if a project contains
data channels that are exposed to cloud resources that are not the
target of the deployment.

If the project has dependent projects, they must be approved first for 
the cloud resources.  If they are not approved, the approval will fail
for this project.

Any previous approvals are cleared by passing in an empty array of cloud resources.

$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try {
    $api_instance->approveProject($body, $sandbox, $project);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->approveProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $body = [WWW::SwaggerClient::Object::array[ResourceReference]->new()]; # array[ResourceReference] | Approve this project for deployment to these cloud resources.

Multiple cloud resources approvals are required if a project contains
data channels that are exposed to cloud resources that are not the
target of the deployment.

If the project has dependent projects, they must be approved first for 
the cloud resources.  If they are not approved, the approval will fail
for this project.

Any previous approvals are cleared by passing in an empty array of cloud resources.

my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    $api_instance->approveProject(body => $body, sandbox => $sandbox, project => $project);
};
if ($@) {
    warn "Exception when calling ProjectApi->approveProject: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
body =  # array[ResourceReference] | Approve this project for deployment to these cloud resources.

Multiple cloud resources approvals are required if a project contains
data channels that are exposed to cloud resources that are not the
target of the deployment.

If the project has dependent projects, they must be approved first for 
the cloud resources.  If they are not approved, the approval will fail
for this project.

Any previous approvals are cleared by passing in an empty array of cloud resources.

sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Approve project for deployment to target cloud resource(s)
    api_instance.approve_project(body, sandbox, project)
except ApiException as e:
    print("Exception when calling ProjectApi->approveProject: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Project approved for cloud resources

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Project has dependencies that have not been approved

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


copyArtifact

Copy an artifact

Create a copy of an existing artifact. On success a reference is returned in the response. Artifacts can only be copied within the same project.


/projects/{sandbox}/{project}/artifacts/{reference}/copy

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/artifacts/{reference}/copy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        CopyArtifactRequest body = ; // CopyArtifactRequest | create a copy of the artifact at this path
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ArtifactReference reference = ; // ArtifactReference | artifact reference to copy encoded as path param of form 'path=\,category=\'
        try {
            apiInstance.copyArtifact(body, sandbox, project, reference);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#copyArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        CopyArtifactRequest body = ; // CopyArtifactRequest | create a copy of the artifact at this path
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ArtifactReference reference = ; // ArtifactReference | artifact reference to copy encoded as path param of form 'path=\,category=\'
        try {
            apiInstance.copyArtifact(body, sandbox, project, reference);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#copyArtifact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
CopyArtifactRequest *body = ; // create a copy of the artifact at this path
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
ArtifactReference *reference = ; // artifact reference to copy encoded as path param of form 'path=\,category=\'

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

// Copy an artifact
[apiInstance copyArtifactWith:body
    sandbox:sandbox
    project:project
    reference:reference
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var body = ; // {{CopyArtifactRequest}} create a copy of the artifact at this path
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var reference = ; // {{ArtifactReference}} artifact reference to copy encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new ProjectApi();
            var body = new CopyArtifactRequest(); // CopyArtifactRequest | create a copy of the artifact at this path
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var reference = new ArtifactReference(); // ArtifactReference | artifact reference to copy encoded as path param of form 'path=\,category=\'

            try
            {
                // Copy an artifact
                apiInstance.copyArtifact(body, sandbox, project, reference);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.copyArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$body = ; // CopyArtifactRequest | create a copy of the artifact at this path
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$reference = ; // ArtifactReference | artifact reference to copy encoded as path param of form 'path=\,category=\'

try {
    $api_instance->copyArtifact($body, $sandbox, $project, $reference);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->copyArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $body = WWW::SwaggerClient::Object::CopyArtifactRequest->new(); # CopyArtifactRequest | create a copy of the artifact at this path
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $reference = ; # ArtifactReference | artifact reference to copy encoded as path param of form 'path=\,category=\'

eval { 
    $api_instance->copyArtifact(body => $body, sandbox => $sandbox, project => $project, reference => $reference);
};
if ($@) {
    warn "Exception when calling ProjectApi->copyArtifact: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
body =  # CopyArtifactRequest | create a copy of the artifact at this path
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
reference =  # ArtifactReference | artifact reference to copy encoded as path param of form 'path=\,category=\'

try: 
    # Copy an artifact
    api_instance.copy_artifact(body, sandbox, project, reference)
except ApiException as e:
    print("Exception when calling ProjectApi->copyArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
reference*
ArtifactReference
artifact reference to copy encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


createProject

Create a new project

Create a new project in a sandbox. The project is associated with the specified space. The project is located at the root of the sandbox unless an optional path is specified. If path is specified the project is located in the sandbox at that path. When the project is published to the associated space the optional path is maintained in the space.


/projects/{sandbox}

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/projects/{sandbox}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        CreateProjectRequest body = ; // CreateProjectRequest | project creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.createProject(body, sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        CreateProjectRequest body = ; // CreateProjectRequest | project creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.createProject(body, sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
CreateProjectRequest *body = ; // project creation parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'

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

// Create a new project
[apiInstance createProjectWith:body
    sandbox:sandbox
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var body = ; // {{CreateProjectRequest}} project creation parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'

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

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

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

            var apiInstance = new ProjectApi();
            var body = new CreateProjectRequest(); // CreateProjectRequest | project creation parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

            try
            {
                // Create a new project
                apiInstance.createProject(body, sandbox);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.createProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$body = ; // CreateProjectRequest | project creation parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $body = WWW::SwaggerClient::Object::CreateProjectRequest->new(); # CreateProjectRequest | project creation parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

eval { 
    $api_instance->createProject(body => $body, sandbox => $sandbox);
};
if ($@) {
    warn "Exception when calling ProjectApi->createProject: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
body =  # CreateProjectRequest | project creation parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

try: 
    # Create a new project
    api_instance.create_project(body, sandbox)
except ApiException as e:
    print("Exception when calling ProjectApi->createProject: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


deleteArtifact

Delete an artifact

Delete an artifact. The artifact is removed immediately from the project.


/projects/{sandbox}/{project}/artifacts/{reference}

Usage and SDK Samples

curl -X DELETE\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/artifacts/{reference}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ArtifactReference reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
        try {
            apiInstance.deleteArtifact(sandbox, project, reference);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#deleteArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ArtifactReference reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
        try {
            apiInstance.deleteArtifact(sandbox, project, reference);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#deleteArtifact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
ArtifactReference *reference = ; // artifact reference encoded as path param of form 'path=\,category=\'

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

// Delete an artifact
[apiInstance deleteArtifactWith:sandbox
    project:project
    reference:reference
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var reference = ; // {{ArtifactReference}} artifact reference encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new ProjectApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var reference = new ArtifactReference(); // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'

            try
            {
                // Delete an artifact
                apiInstance.deleteArtifact(sandbox, project, reference);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.deleteArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'

try {
    $api_instance->deleteArtifact($sandbox, $project, $reference);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->deleteArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $reference = ; # ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'

eval { 
    $api_instance->deleteArtifact(sandbox => $sandbox, project => $project, reference => $reference);
};
if ($@) {
    warn "Exception when calling ProjectApi->deleteArtifact: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
reference =  # ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'

try: 
    # Delete an artifact
    api_instance.delete_artifact(sandbox, project, reference)
except ApiException as e:
    print("Exception when calling ProjectApi->deleteArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
reference*
ArtifactReference
artifact reference encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required

Responses

Status: 200 - Artifact successfully deleted

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


deleteProject

Delete a project

Delete a project and all of its contents. The project is removed immediately from the sandbox. If the *delete* query parameter is set to true, the project is also scheduled for deletion from the backing space on the next publish of a checkpoint containing the delete.


/projects/{sandbox}/{project}

Usage and SDK Samples

curl -X DELETE\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}?delete="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        Boolean delete = true; // Boolean | schedule project for deletion from backing space
        try {
            apiInstance.deleteProject(sandbox, project, delete);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#deleteProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        Boolean delete = true; // Boolean | schedule project for deletion from backing space
        try {
            apiInstance.deleteProject(sandbox, project, delete);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#deleteProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
Boolean *delete = true; // schedule project for deletion from backing space (optional) (default to false)

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

// Delete a project
[apiInstance deleteProjectWith:sandbox
    project:project
    delete:delete
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var opts = { 
  'delete': true // {{Boolean}} schedule project for deletion from backing space
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProject(sandbox, project, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ProjectApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var delete = true;  // Boolean | schedule project for deletion from backing space (optional)  (default to false)

            try
            {
                // Delete a project
                apiInstance.deleteProject(sandbox, project, delete);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.deleteProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$delete = true; // Boolean | schedule project for deletion from backing space

try {
    $api_instance->deleteProject($sandbox, $project, $delete);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->deleteProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $delete = true; # Boolean | schedule project for deletion from backing space

eval { 
    $api_instance->deleteProject(sandbox => $sandbox, project => $project, delete => $delete);
};
if ($@) {
    warn "Exception when calling ProjectApi->deleteProject: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
delete = true # Boolean | schedule project for deletion from backing space (optional) (default to false)

try: 
    # Delete a project
    api_instance.delete_project(sandbox, project, delete=delete)
except ApiException as e:
    print("Exception when calling ProjectApi->deleteProject: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Query parameters
Name Description
delete
Boolean
schedule project for deletion from backing space

Responses

Status: 200 - Project successfully deleted

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


duplicateProject

Duplicate an existing project

Duplicate an existing project. The duplicated project contains copies of all artifacts in the original project. On success a reference to the duplicate project is returned. The new project only exists in the sandbox until it is published to a space.


/projects/{sandbox}/{project}/duplicate

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/duplicate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        DuplicateProjectRequest body = ; // DuplicateProjectRequest | The space, project identifier, and project version for the new duplicate project.

version and space are optional, and if not set, the values from the original project is used.

        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.duplicateProject(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#duplicateProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        DuplicateProjectRequest body = ; // DuplicateProjectRequest | The space, project identifier, and project version for the new duplicate project.

version and space are optional, and if not set, the values from the original project is used.

        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.duplicateProject(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#duplicateProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
DuplicateProjectRequest *body = ; // The space, project identifier, and project version for the new duplicate project.

version and space are optional, and if not set, the values from the original project is used.

SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Duplicate an existing project
[apiInstance duplicateProjectWith:body
    sandbox:sandbox
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var body = ; // {{DuplicateProjectRequest}} The space, project identifier, and project version for the new duplicate project.

version and space are optional, and if not set, the values from the original project is used.

var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ProjectApi();
            var body = new DuplicateProjectRequest(); // DuplicateProjectRequest | The space, project identifier, and project version for the new duplicate project.

version and space are optional, and if not set, the values from the original project is used.

            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Duplicate an existing project
                apiInstance.duplicateProject(body, sandbox, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.duplicateProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$body = ; // DuplicateProjectRequest | The space, project identifier, and project version for the new duplicate project.

version and space are optional, and if not set, the values from the original project is used.

$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try {
    $api_instance->duplicateProject($body, $sandbox, $project);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->duplicateProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $body = WWW::SwaggerClient::Object::DuplicateProjectRequest->new(); # DuplicateProjectRequest | The space, project identifier, and project version for the new duplicate project.

version and space are optional, and if not set, the values from the original project is used.

my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    $api_instance->duplicateProject(body => $body, sandbox => $sandbox, project => $project);
};
if ($@) {
    warn "Exception when calling ProjectApi->duplicateProject: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
body =  # DuplicateProjectRequest | The space, project identifier, and project version for the new duplicate project.

version and space are optional, and if not set, the values from the original project is used.

sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Duplicate an existing project
    api_instance.duplicate_project(body, sandbox, project)
except ApiException as e:
    print("Exception when calling ProjectApi->duplicateProject: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


exportProjectArchive

Export a project with all of its contents

Export a project with its contents in an archive. The project is exported in its current state in the sandbox.


/projects/{sandbox}/{project}/export

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/zip,application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/export"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            byte[] result = apiInstance.exportProjectArchive(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#exportProjectArchive");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            byte[] result = apiInstance.exportProjectArchive(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#exportProjectArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Export a project with all of its contents
[apiInstance exportProjectArchiveWith:sandbox
    project:project
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ProjectApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Export a project with all of its contents
                byte[] result = apiInstance.exportProjectArchive(sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.exportProjectArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->exportProjectArchive(sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->exportProjectArchive: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Export a project with all of its contents
    api_response = api_instance.export_project_archive(sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->exportProjectArchive: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required

Responses

Status: 200 - Exported project archive

Name Type Format Description
Content-Disposition String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getArtifact

Get an artifact

Get an artifact, optionally returning its contents The returned artifact may be any which may exist in a project, including *ManagedFile*, *DataChannel*, *Flow*, *Model*, *Pipeline*, *TupleSchema*, *CloudDeployDescriptor*, and/or *StreamingDeployDescriptor*. If the *content* query parameter is set to *false* (default value), Model.content and ManagedFile.content are omitted from the response. Setting the *content* query parameter to *true* returns the content for these artifacts. Omitting content minimizes the size of the response if the data is not needed.


/projects/{sandbox}/{project}/artifacts/{reference}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/artifacts/{reference}?content="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ArtifactReference reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
        Boolean content = true; // Boolean | include content in response?
        try {
            Artifact result = apiInstance.getArtifact(sandbox, project, reference, content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ArtifactReference reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
        Boolean content = true; // Boolean | include content in response?
        try {
            Artifact result = apiInstance.getArtifact(sandbox, project, reference, content);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getArtifact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
ArtifactReference *reference = ; // artifact reference encoded as path param of form 'path=\,category=\'
Boolean *content = true; // include content in response? (optional) (default to false)

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

// Get an artifact
[apiInstance getArtifactWith:sandbox
    project:project
    reference:reference
    content:content
              completionHandler: ^(Artifact output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var reference = ; // {{ArtifactReference}} artifact reference encoded as path param of form 'path=\,category=\'
var opts = { 
  'content': true // {{Boolean}} include content in response?
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArtifact(sandbox, project, reference, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ProjectApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var reference = new ArtifactReference(); // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
            var content = true;  // Boolean | include content in response? (optional)  (default to false)

            try
            {
                // Get an artifact
                Artifact result = apiInstance.getArtifact(sandbox, project, reference, content);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.getArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
$content = true; // Boolean | include content in response?

try {
    $result = $api_instance->getArtifact($sandbox, $project, $reference, $content);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->getArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $reference = ; # ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
my $content = true; # Boolean | include content in response?

eval { 
    my $result = $api_instance->getArtifact(sandbox => $sandbox, project => $project, reference => $reference, content => $content);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->getArtifact: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
reference =  # ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
content = true # Boolean | include content in response? (optional) (default to false)

try: 
    # Get an artifact
    api_response = api_instance.get_artifact(sandbox, project, reference, content=content)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->getArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
reference*
ArtifactReference
artifact reference encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Query parameters
Name Description
content
Boolean
include content in response?

Responses

Status: 200 - Artifact data

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getArtifactHistory

Get artifact history

Get artifact commit history


/projects/{sandbox}/{project}/artifacts/{reference}/history

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/artifacts/{reference}/history?count=&before="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ArtifactReference reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
        Integer count = 56; // Integer | maximum number of history records to return
        Date before = 2013-10-20T19:20:30+01:00; // Date | only return records before this date
        try {
            array[History] result = apiInstance.getArtifactHistory(sandbox, project, reference, count, before);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getArtifactHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ArtifactReference reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
        Integer count = 56; // Integer | maximum number of history records to return
        Date before = 2013-10-20T19:20:30+01:00; // Date | only return records before this date
        try {
            array[History] result = apiInstance.getArtifactHistory(sandbox, project, reference, count, before);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getArtifactHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
ArtifactReference *reference = ; // artifact reference encoded as path param of form 'path=\,category=\'
Integer *count = 56; // maximum number of history records to return (optional) (default to 10)
Date *before = 2013-10-20T19:20:30+01:00; // only return records before this date (optional)

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

// Get artifact history
[apiInstance getArtifactHistoryWith:sandbox
    project:project
    reference:reference
    count:count
    before:before
              completionHandler: ^(array[History] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var reference = ; // {{ArtifactReference}} artifact reference encoded as path param of form 'path=\,category=\'
var opts = { 
  'count': 56, // {{Integer}} maximum number of history records to return
  'before': 2013-10-20T19:20:30+01:00 // {{Date}} only return records before this date
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArtifactHistory(sandbox, project, reference, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ProjectApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var reference = new ArtifactReference(); // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
            var count = 56;  // Integer | maximum number of history records to return (optional)  (default to 10)
            var before = 2013-10-20T19:20:30+01:00;  // Date | only return records before this date (optional) 

            try
            {
                // Get artifact history
                array[History] result = apiInstance.getArtifactHistory(sandbox, project, reference, count, before);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.getArtifactHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
$count = 56; // Integer | maximum number of history records to return
$before = 2013-10-20T19:20:30+01:00; // Date | only return records before this date

try {
    $result = $api_instance->getArtifactHistory($sandbox, $project, $reference, $count, $before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->getArtifactHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $reference = ; # ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
my $count = 56; # Integer | maximum number of history records to return
my $before = 2013-10-20T19:20:30+01:00; # Date | only return records before this date

eval { 
    my $result = $api_instance->getArtifactHistory(sandbox => $sandbox, project => $project, reference => $reference, count => $count, before => $before);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->getArtifactHistory: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
reference =  # ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
count = 56 # Integer | maximum number of history records to return (optional) (default to 10)
before = 2013-10-20T19:20:30+01:00 # Date | only return records before this date (optional)

try: 
    # Get artifact history
    api_response = api_instance.get_artifact_history(sandbox, project, reference, count=count, before=before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->getArtifactHistory: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
reference*
ArtifactReference
artifact reference encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Query parameters
Name Description
count
Integer (int32)
maximum number of history records to return
before
Date (date-time)
only return records before this date

Responses

Status: 200 - Artifact history

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getArtifacts

Get project artifacts

Get all artifacts in a project. The returned artifacts may include any which may exist in a project, including *ManagedFile*, *DataChannel*, *Flow*, *Model*, *Pipeline*, *TupleSchema*, *CloudDeployDescriptor*, and/or *StreamingDeployDescriptor*. Model.content and ManagedFile.content are omitted from the response. The content must be individually fetched for these artifact types using GET /projects/{sandbox}/{project}/artifacts/{reference}


/projects/{sandbox}/{project}/artifacts

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/artifacts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[Artifact] result = apiInstance.getArtifacts(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getArtifacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[Artifact] result = apiInstance.getArtifacts(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getArtifacts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Get project artifacts
[apiInstance getArtifactsWith:sandbox
    project:project
              completionHandler: ^(array[Artifact] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ProjectApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Get project artifacts
                array[Artifact] result = apiInstance.getArtifacts(sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.getArtifacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->getArtifacts(sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->getArtifacts: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Get project artifacts
    api_response = api_instance.get_artifacts(sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->getArtifacts: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required

Responses

Status: 200 - Project artifact

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getProject

Get project

Get a sandbox project. A resource does not exist error is returned if no project with specified identifier exists or user does not have read access.


/projects/{sandbox}/{project}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            Project result = apiInstance.getProject(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            Project result = apiInstance.getProject(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Get project
[apiInstance getProjectWith:sandbox
    project:project
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ProjectApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Get project
                Project result = apiInstance.getProject(sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.getProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->getProject(sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->getProject: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Get project
    api_response = api_instance.get_project(sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->getProject: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required

Responses

Status: 200 - Project data

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getProjectHistory

Get project history

Get project commit history


/projects/{sandbox}/{project}/history

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/history?count=&before="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        Integer count = 56; // Integer | maximum number of history records to return
        Date before = 2013-10-20T19:20:30+01:00; // Date | only return records before this date
        try {
            array[History] result = apiInstance.getProjectHistory(sandbox, project, count, before);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProjectHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        Integer count = 56; // Integer | maximum number of history records to return
        Date before = 2013-10-20T19:20:30+01:00; // Date | only return records before this date
        try {
            array[History] result = apiInstance.getProjectHistory(sandbox, project, count, before);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProjectHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
Integer *count = 56; // maximum number of history records to return (optional) (default to 10)
Date *before = 2013-10-20T19:20:30+01:00; // only return records before this date (optional)

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

// Get project history
[apiInstance getProjectHistoryWith:sandbox
    project:project
    count:count
    before:before
              completionHandler: ^(array[History] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var opts = { 
  'count': 56, // {{Integer}} maximum number of history records to return
  'before': 2013-10-20T19:20:30+01:00 // {{Date}} only return records before this date
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectHistory(sandbox, project, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ProjectApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var count = 56;  // Integer | maximum number of history records to return (optional)  (default to 10)
            var before = 2013-10-20T19:20:30+01:00;  // Date | only return records before this date (optional) 

            try
            {
                // Get project history
                array[History] result = apiInstance.getProjectHistory(sandbox, project, count, before);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.getProjectHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$count = 56; // Integer | maximum number of history records to return
$before = 2013-10-20T19:20:30+01:00; // Date | only return records before this date

try {
    $result = $api_instance->getProjectHistory($sandbox, $project, $count, $before);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->getProjectHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $count = 56; # Integer | maximum number of history records to return
my $before = 2013-10-20T19:20:30+01:00; # Date | only return records before this date

eval { 
    my $result = $api_instance->getProjectHistory(sandbox => $sandbox, project => $project, count => $count, before => $before);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->getProjectHistory: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
count = 56 # Integer | maximum number of history records to return (optional) (default to 10)
before = 2013-10-20T19:20:30+01:00 # Date | only return records before this date (optional)

try: 
    # Get project history
    api_response = api_instance.get_project_history(sandbox, project, count=count, before=before)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->getProjectHistory: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Query parameters
Name Description
count
Integer (int32)
maximum number of history records to return
before
Date (date-time)
only return records before this date

Responses

Status: 200 - Project history

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getProjectStatus

Get status of artifacts contained in project

Return status for all artifacts in a project.


/projects/{sandbox}/{project}/status

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            ProjectArtifactStatus result = apiInstance.getProjectStatus(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProjectStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            ProjectArtifactStatus result = apiInstance.getProjectStatus(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProjectStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Get status of artifacts contained in project
[apiInstance getProjectStatusWith:sandbox
    project:project
              completionHandler: ^(ProjectArtifactStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ProjectApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Get status of artifacts contained in project
                ProjectArtifactStatus result = apiInstance.getProjectStatus(sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.getProjectStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->getProjectStatus(sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->getProjectStatus: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Get status of artifacts contained in project
    api_response = api_instance.get_project_status(sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->getProjectStatus: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required

Responses

Status: 200 - Project artifact status

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getProjects

Get projects in sandbox

Get all projects in sandbox


/projects/{sandbox}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/projects/{sandbox}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            array[Project] result = apiInstance.getProjects(sandbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            array[Project] result = apiInstance.getProjects(sandbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#getProjects");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'

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

// Get projects in sandbox
[apiInstance getProjectsWith:sandbox
              completionHandler: ^(array[Project] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'

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

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

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

            var apiInstance = new ProjectApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

            try
            {
                // Get projects in sandbox
                array[Project] result = apiInstance.getProjects(sandbox);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.getProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

eval { 
    my $result = $api_instance->getProjects(sandbox => $sandbox);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->getProjects: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

try: 
    # Get projects in sandbox
    api_response = api_instance.get_projects(sandbox)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->getProjects: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required

Responses

Status: 200 - Sandbox projects

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


importProjectArchive

Import a project archive into a sandbox, and associate with a space

Import a previously exported project archive to a sandbox


/projects/{sandbox}/{space}/import

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/zip"\
"/artifacts/v2/projects/{sandbox}/{space}/import"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        Object body = ; // Object | externalized project
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        SpaceReference space = ; // SpaceReference | space name encoded as path param of form 'name=\'
        try {
            apiInstance.importProjectArchive(body, sandbox, space);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#importProjectArchive");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Object body = ; // Object | externalized project
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        SpaceReference space = ; // SpaceReference | space name encoded as path param of form 'name=\'
        try {
            apiInstance.importProjectArchive(body, sandbox, space);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#importProjectArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
Object *body = ; // externalized project
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
SpaceReference *space = ; // space name encoded as path param of form 'name=\'

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

// Import a project archive into a sandbox, and associate with a space
[apiInstance importProjectArchiveWith:body
    sandbox:sandbox
    space:space
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var body = ; // {{Object}} externalized project
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var space = ; // {{SpaceReference}} space name encoded as path param of form 'name=\'

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

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

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

            var apiInstance = new ProjectApi();
            var body = new Object(); // Object | externalized project
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var space = new SpaceReference(); // SpaceReference | space name encoded as path param of form 'name=\'

            try
            {
                // Import a project archive into a sandbox, and associate with a space
                apiInstance.importProjectArchive(body, sandbox, space);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.importProjectArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$body = ; // Object | externalized project
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$space = ; // SpaceReference | space name encoded as path param of form 'name=\'

try {
    $api_instance->importProjectArchive($body, $sandbox, $space);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->importProjectArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $body = WWW::SwaggerClient::Object::Object->new(); # Object | externalized project
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $space = ; # SpaceReference | space name encoded as path param of form 'name=\'

eval { 
    $api_instance->importProjectArchive(body => $body, sandbox => $sandbox, space => $space);
};
if ($@) {
    warn "Exception when calling ProjectApi->importProjectArchive: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
body =  # Object | externalized project
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
space =  # SpaceReference | space name encoded as path param of form 'name=\'

try: 
    # Import a project archive into a sandbox, and associate with a space
    api_instance.import_project_archive(body, sandbox, space)
except ApiException as e:
    print("Exception when calling ProjectApi->importProjectArchive: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
space*
SpaceReference
space name encoded as path param of form 'name=\<space name\>'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


moveArtifact

Move an artifact to a new project

Move an existing artifact from one project to another. On success a reference is returned in the response.


/projects/{sandbox}/{project}/artifacts/{reference}/move

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/artifacts/{reference}/move"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        MoveArtifactRequest body = ; // MoveArtifactRequest | move artifact to this project
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ArtifactReference reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
        try {
            apiInstance.moveArtifact(body, sandbox, project, reference);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#moveArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        MoveArtifactRequest body = ; // MoveArtifactRequest | move artifact to this project
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ArtifactReference reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
        try {
            apiInstance.moveArtifact(body, sandbox, project, reference);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#moveArtifact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
MoveArtifactRequest *body = ; // move artifact to this project
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
ArtifactReference *reference = ; // artifact reference encoded as path param of form 'path=\,category=\'

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

// Move an artifact to a new project
[apiInstance moveArtifactWith:body
    sandbox:sandbox
    project:project
    reference:reference
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var body = ; // {{MoveArtifactRequest}} move artifact to this project
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var reference = ; // {{ArtifactReference}} artifact reference encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new ProjectApi();
            var body = new MoveArtifactRequest(); // MoveArtifactRequest | move artifact to this project
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var reference = new ArtifactReference(); // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'

            try
            {
                // Move an artifact to a new project
                apiInstance.moveArtifact(body, sandbox, project, reference);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.moveArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$body = ; // MoveArtifactRequest | move artifact to this project
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'

try {
    $api_instance->moveArtifact($body, $sandbox, $project, $reference);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->moveArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $body = WWW::SwaggerClient::Object::MoveArtifactRequest->new(); # MoveArtifactRequest | move artifact to this project
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $reference = ; # ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'

eval { 
    $api_instance->moveArtifact(body => $body, sandbox => $sandbox, project => $project, reference => $reference);
};
if ($@) {
    warn "Exception when calling ProjectApi->moveArtifact: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
body =  # MoveArtifactRequest | move artifact to this project
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
reference =  # ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'

try: 
    # Move an artifact to a new project
    api_instance.move_artifact(body, sandbox, project, reference)
except ApiException as e:
    print("Exception when calling ProjectApi->moveArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
reference*
ArtifactReference
artifact reference encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


moveProject

Move a project

Move an existing project to a new location in the sandbox. A path with no segments will move the project to the base of the sandbox. On success a reference to the moved project is returned and the project is marked dirty.


/projects/{sandbox}/{project}/move

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/move"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        MoveProjectRequest body = ; // MoveProjectRequest | new project path
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.moveProject(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#moveProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        MoveProjectRequest body = ; // MoveProjectRequest | new project path
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.moveProject(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#moveProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
MoveProjectRequest *body = ; // new project path
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Move a project
[apiInstance moveProjectWith:body
    sandbox:sandbox
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var body = ; // {{MoveProjectRequest}} new project path
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ProjectApi();
            var body = new MoveProjectRequest(); // MoveProjectRequest | new project path
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Move a project
                apiInstance.moveProject(body, sandbox, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.moveProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$body = ; // MoveProjectRequest | new project path
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try {
    $api_instance->moveProject($body, $sandbox, $project);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->moveProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $body = WWW::SwaggerClient::Object::MoveProjectRequest->new(); # MoveProjectRequest | new project path
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    $api_instance->moveProject(body => $body, sandbox => $sandbox, project => $project);
};
if ($@) {
    warn "Exception when calling ProjectApi->moveProject: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
body =  # MoveProjectRequest | new project path
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Move a project
    api_instance.move_project(body, sandbox, project)
except ApiException as e:
    print("Exception when calling ProjectApi->moveProject: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


renameArtifact

Rename an artifact

Rename an existing artifact. On success a reference to the renamed artifact is returned. Artifacts can only be renamed within the same project. See POST /projects/{sandbox}/{project}/artifacts/{path}/move to move an artifact to another project.


/projects/{sandbox}/{project}/artifacts/{reference}/rename

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/artifacts/{reference}/rename"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        RenameArtifactRequest body = ; // RenameArtifactRequest | rename artifact to this path
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ArtifactReference reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
        try {
            apiInstance.renameArtifact(body, sandbox, project, reference);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#renameArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        RenameArtifactRequest body = ; // RenameArtifactRequest | rename artifact to this path
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        ArtifactReference reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'
        try {
            apiInstance.renameArtifact(body, sandbox, project, reference);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#renameArtifact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
RenameArtifactRequest *body = ; // rename artifact to this path
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
ArtifactReference *reference = ; // artifact reference encoded as path param of form 'path=\,category=\'

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

// Rename an artifact
[apiInstance renameArtifactWith:body
    sandbox:sandbox
    project:project
    reference:reference
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var body = ; // {{RenameArtifactRequest}} rename artifact to this path
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var reference = ; // {{ArtifactReference}} artifact reference encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new ProjectApi();
            var body = new RenameArtifactRequest(); // RenameArtifactRequest | rename artifact to this path
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var reference = new ArtifactReference(); // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'

            try
            {
                // Rename an artifact
                apiInstance.renameArtifact(body, sandbox, project, reference);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.renameArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$body = ; // RenameArtifactRequest | rename artifact to this path
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$reference = ; // ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'

try {
    $api_instance->renameArtifact($body, $sandbox, $project, $reference);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->renameArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $body = WWW::SwaggerClient::Object::RenameArtifactRequest->new(); # RenameArtifactRequest | rename artifact to this path
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $reference = ; # ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'

eval { 
    $api_instance->renameArtifact(body => $body, sandbox => $sandbox, project => $project, reference => $reference);
};
if ($@) {
    warn "Exception when calling ProjectApi->renameArtifact: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
body =  # RenameArtifactRequest | rename artifact to this path
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
reference =  # ArtifactReference | artifact reference encoded as path param of form 'path=\,category=\'

try: 
    # Rename an artifact
    api_instance.rename_artifact(body, sandbox, project, reference)
except ApiException as e:
    print("Exception when calling ProjectApi->renameArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
reference*
ArtifactReference
artifact reference encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


renameProject

Rename a project

Rename an existing project. On success a reference to the renamed project is returned and the project is marked dirty in the sandbox.


/projects/{sandbox}/{project}/rename

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/rename"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        RenameProjectRequest body = ; // RenameProjectRequest | new project identifier
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.renameProject(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#renameProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        RenameProjectRequest body = ; // RenameProjectRequest | new project identifier
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.renameProject(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#renameProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
RenameProjectRequest *body = ; // new project identifier
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Rename a project
[apiInstance renameProjectWith:body
    sandbox:sandbox
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var body = ; // {{RenameProjectRequest}} new project identifier
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ProjectApi();
            var body = new RenameProjectRequest(); // RenameProjectRequest | new project identifier
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Rename a project
                apiInstance.renameProject(body, sandbox, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.renameProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$body = ; // RenameProjectRequest | new project identifier
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try {
    $api_instance->renameProject($body, $sandbox, $project);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->renameProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $body = WWW::SwaggerClient::Object::RenameProjectRequest->new(); # RenameProjectRequest | new project identifier
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    $api_instance->renameProject(body => $body, sandbox => $sandbox, project => $project);
};
if ($@) {
    warn "Exception when calling ProjectApi->renameProject: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
body =  # RenameProjectRequest | new project identifier
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Rename a project
    api_instance.rename_project(body, sandbox, project)
except ApiException as e:
    print("Exception when calling ProjectApi->renameProject: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


updateProject

Update a project

Update an existing project.


/projects/{sandbox}/{project}

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        UpdateProjectRequest body = ; // UpdateProjectRequest | project update parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            Project result = apiInstance.updateProject(body, sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#updateProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        UpdateProjectRequest body = ; // UpdateProjectRequest | project update parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            Project result = apiInstance.updateProject(body, sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#updateProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
UpdateProjectRequest *body = ; // project update parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Update a project
[apiInstance updateProjectWith:body
    sandbox:sandbox
    project:project
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var body = ; // {{UpdateProjectRequest}} project update parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new ProjectApi();
            var body = new UpdateProjectRequest(); // UpdateProjectRequest | project update parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Update a project
                Project result = apiInstance.updateProject(body, sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.updateProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$body = ; // UpdateProjectRequest | project update parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $body = WWW::SwaggerClient::Object::UpdateProjectRequest->new(); # UpdateProjectRequest | project update parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->updateProject(body => $body, sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->updateProject: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
body =  # UpdateProjectRequest | project update parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Update a project
    api_response = api_instance.update_project(body, sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->updateProject: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated project

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


validateProject

Validate a project

Validate a project. Project validation performs these actions * verify external dependencies * verify flows, models, pipelines, and data channels


/projects/{sandbox}/{project}/validate

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/projects/{sandbox}/{project}/validate?failOnWarnings="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectApi;

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

public class ProjectApiExample {

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


        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            apiInstance.validateProject(sandbox, project, failOnWarnings);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#validateProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectApi;

public class ProjectApiExample {

    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            apiInstance.validateProject(sandbox, project, failOnWarnings);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#validateProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
Boolean *failOnWarnings = true; // true to fail validation on warnings (optional) (default to false)

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

// Validate a project
[apiInstance validateProjectWith:sandbox
    project:project
    failOnWarnings:failOnWarnings
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.ProjectApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var opts = { 
  'failOnWarnings': true // {{Boolean}} true to fail validation on warnings
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.validateProject(sandbox, project, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new ProjectApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var failOnWarnings = true;  // Boolean | true to fail validation on warnings (optional)  (default to false)

            try
            {
                // Validate a project
                apiInstance.validateProject(sandbox, project, failOnWarnings);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectApi.validateProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiProjectApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$failOnWarnings = true; // Boolean | true to fail validation on warnings

try {
    $api_instance->validateProject($sandbox, $project, $failOnWarnings);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->validateProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProjectApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $failOnWarnings = true; # Boolean | true to fail validation on warnings

eval { 
    $api_instance->validateProject(sandbox => $sandbox, project => $project, failOnWarnings => $failOnWarnings);
};
if ($@) {
    warn "Exception when calling ProjectApi->validateProject: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProjectApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
failOnWarnings = true # Boolean | true to fail validation on warnings (optional) (default to false)

try: 
    # Validate a project
    api_instance.validate_project(sandbox, project, failOnWarnings=failOnWarnings)
except ApiException as e:
    print("Exception when calling ProjectApi->validateProject: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Query parameters
Name Description
failOnWarnings
Boolean
true to fail validation on warnings

Responses

Status: 200 - Project validation successful

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Artifact validation failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


Sandbox

addProjectToSandbox

Add an existing project from a backing space to sandbox

Add a project from a backing space to a sandbox. When a project is added to a sandbox any approvals are removed.


/sandboxes/{sandbox}/add

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/sandboxes/{sandbox}/add"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SandboxApi;

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

public class SandboxApiExample {

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


        SandboxApi apiInstance = new SandboxApi();
        ProjectIdentifier body = ; // ProjectIdentifier | project identifier for project to add
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.addProjectToSandbox(body, sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#addProjectToSandbox");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SandboxApi;

public class SandboxApiExample {

    public static void main(String[] args) {
        SandboxApi apiInstance = new SandboxApi();
        ProjectIdentifier body = ; // ProjectIdentifier | project identifier for project to add
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.addProjectToSandbox(body, sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#addProjectToSandbox");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
ProjectIdentifier *body = ; // project identifier for project to add
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'

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

// Add an existing project from a backing space to sandbox
[apiInstance addProjectToSandboxWith:body
    sandbox:sandbox
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.SandboxApi()
var body = ; // {{ProjectIdentifier}} project identifier for project to add
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'

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

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

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

            var apiInstance = new SandboxApi();
            var body = new ProjectIdentifier(); // ProjectIdentifier | project identifier for project to add
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

            try
            {
                // Add an existing project from a backing space to sandbox
                apiInstance.addProjectToSandbox(body, sandbox);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SandboxApi.addProjectToSandbox: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiSandboxApi();
$body = ; // ProjectIdentifier | project identifier for project to add
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SandboxApi->new();
my $body = WWW::SwaggerClient::Object::ProjectIdentifier->new(); # ProjectIdentifier | project identifier for project to add
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

eval { 
    $api_instance->addProjectToSandbox(body => $body, sandbox => $sandbox);
};
if ($@) {
    warn "Exception when calling SandboxApi->addProjectToSandbox: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SandboxApi()
body =  # ProjectIdentifier | project identifier for project to add
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

try: 
    # Add an existing project from a backing space to sandbox
    api_instance.add_project_to_sandbox(body, sandbox)
except ApiException as e:
    print("Exception when calling SandboxApi->addProjectToSandbox: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


createSandbox

Create a new sandbox

Create a new sandbox associated with one or more spaces. The sandbox is owned by the login user. At least one space must be specified when creating a sandbox. Projects are imported from the associated spaces into the sandbox to be modified.


/sandboxes

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/sandboxes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SandboxApi;

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

public class SandboxApiExample {

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


        SandboxApi apiInstance = new SandboxApi();
        CreateSandboxRequest body = ; // CreateSandboxRequest | create sandbox properties
        try {
            apiInstance.createSandbox(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#createSandbox");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SandboxApi;

public class SandboxApiExample {

    public static void main(String[] args) {
        SandboxApi apiInstance = new SandboxApi();
        CreateSandboxRequest body = ; // CreateSandboxRequest | create sandbox properties
        try {
            apiInstance.createSandbox(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#createSandbox");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
CreateSandboxRequest *body = ; // create sandbox properties

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

// Create a new sandbox
[apiInstance createSandboxWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.SandboxApi()
var body = ; // {{CreateSandboxRequest}} create sandbox properties

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

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

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

            var apiInstance = new SandboxApi();
            var body = new CreateSandboxRequest(); // CreateSandboxRequest | create sandbox properties

            try
            {
                // Create a new sandbox
                apiInstance.createSandbox(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SandboxApi.createSandbox: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiSandboxApi();
$body = ; // CreateSandboxRequest | create sandbox properties

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SandboxApi->new();
my $body = WWW::SwaggerClient::Object::CreateSandboxRequest->new(); # CreateSandboxRequest | create sandbox properties

eval { 
    $api_instance->createSandbox(body => $body);
};
if ($@) {
    warn "Exception when calling SandboxApi->createSandbox: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SandboxApi()
body =  # CreateSandboxRequest | create sandbox properties

try: 
    # Create a new sandbox
    api_instance.create_sandbox(body)
except ApiException as e:
    print("Exception when calling SandboxApi->createSandbox: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 500 - Internal server error, contact support


deleteSandbox

Delete an existing sandbox

Delete an existing sandbox.


/sandboxes/{sandbox}

Usage and SDK Samples

curl -X DELETE\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/sandboxes/{sandbox}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SandboxApi;

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

public class SandboxApiExample {

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


        SandboxApi apiInstance = new SandboxApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.deleteSandbox(sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#deleteSandbox");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SandboxApi;

public class SandboxApiExample {

    public static void main(String[] args) {
        SandboxApi apiInstance = new SandboxApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.deleteSandbox(sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#deleteSandbox");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'

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

// Delete an existing sandbox
[apiInstance deleteSandboxWith:sandbox
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.SandboxApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'

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

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

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

            var apiInstance = new SandboxApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

            try
            {
                // Delete an existing sandbox
                apiInstance.deleteSandbox(sandbox);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SandboxApi.deleteSandbox: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiSandboxApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SandboxApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

eval { 
    $api_instance->deleteSandbox(sandbox => $sandbox);
};
if ($@) {
    warn "Exception when calling SandboxApi->deleteSandbox: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SandboxApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

try: 
    # Delete an existing sandbox
    api_instance.delete_sandbox(sandbox)
except ApiException as e:
    print("Exception when calling SandboxApi->deleteSandbox: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required

Responses

Status: 200 - Sandbox deleted

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getSandbox

Get sandbox

Get sandbox by name. A resource does not exist error is returned if no sandbox with specified name exists or user does not have read access.


/sandboxes/{sandbox}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/sandboxes/{sandbox}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SandboxApi;

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

public class SandboxApiExample {

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


        SandboxApi apiInstance = new SandboxApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            Sandbox result = apiInstance.getSandbox(sandbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#getSandbox");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SandboxApi;

public class SandboxApiExample {

    public static void main(String[] args) {
        SandboxApi apiInstance = new SandboxApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            Sandbox result = apiInstance.getSandbox(sandbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#getSandbox");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'

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

// Get sandbox
[apiInstance getSandboxWith:sandbox
              completionHandler: ^(Sandbox output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.SandboxApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'

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

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

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

            var apiInstance = new SandboxApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

            try
            {
                // Get sandbox
                Sandbox result = apiInstance.getSandbox(sandbox);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SandboxApi.getSandbox: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiSandboxApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SandboxApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

eval { 
    my $result = $api_instance->getSandbox(sandbox => $sandbox);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SandboxApi->getSandbox: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SandboxApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

try: 
    # Get sandbox
    api_response = api_instance.get_sandbox(sandbox)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SandboxApi->getSandbox: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required

Responses

Status: 200 - Sandbox

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getSandboxes

Get sandboxes

Get all sandboxes visible to the login user


/sandboxes

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/sandboxes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SandboxApi;

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

public class SandboxApiExample {

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


        SandboxApi apiInstance = new SandboxApi();
        try {
            array[Sandbox] result = apiInstance.getSandboxes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#getSandboxes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SandboxApi;

public class SandboxApiExample {

    public static void main(String[] args) {
        SandboxApi apiInstance = new SandboxApi();
        try {
            array[Sandbox] result = apiInstance.getSandboxes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#getSandboxes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];

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

// Get sandboxes
[apiInstance getSandboxesWithCompletionHandler: 
              ^(array[Sandbox] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


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

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

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

            var apiInstance = new SandboxApi();

            try
            {
                // Get sandboxes
                array[Sandbox] result = apiInstance.getSandboxes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SandboxApi.getSandboxes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

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

eval { 
    my $result = $api_instance->getSandboxes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SandboxApi->getSandboxes: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

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

try: 
    # Get sandboxes
    api_response = api_instance.get_sandboxes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SandboxApi->getSandboxes: %s\n" % e)

Parameters

Responses

Status: 200 - User sandboxes

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


renameSandbox

Rename a sandbox

Rename an existing sandbox. On success a reference to the renamed sandbox is returned.


/sandboxes/{sandbox}/rename

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/sandboxes/{sandbox}/rename"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SandboxApi;

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

public class SandboxApiExample {

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


        SandboxApi apiInstance = new SandboxApi();
        RenameSandboxRequest body = ; // RenameSandboxRequest | new sandbox name
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.renameSandbox(body, sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#renameSandbox");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SandboxApi;

public class SandboxApiExample {

    public static void main(String[] args) {
        SandboxApi apiInstance = new SandboxApi();
        RenameSandboxRequest body = ; // RenameSandboxRequest | new sandbox name
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            apiInstance.renameSandbox(body, sandbox);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#renameSandbox");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
RenameSandboxRequest *body = ; // new sandbox name
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'

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

// Rename a sandbox
[apiInstance renameSandboxWith:body
    sandbox:sandbox
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.SandboxApi()
var body = ; // {{RenameSandboxRequest}} new sandbox name
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'

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

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

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

            var apiInstance = new SandboxApi();
            var body = new RenameSandboxRequest(); // RenameSandboxRequest | new sandbox name
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

            try
            {
                // Rename a sandbox
                apiInstance.renameSandbox(body, sandbox);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SandboxApi.renameSandbox: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiSandboxApi();
$body = ; // RenameSandboxRequest | new sandbox name
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SandboxApi->new();
my $body = WWW::SwaggerClient::Object::RenameSandboxRequest->new(); # RenameSandboxRequest | new sandbox name
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

eval { 
    $api_instance->renameSandbox(body => $body, sandbox => $sandbox);
};
if ($@) {
    warn "Exception when calling SandboxApi->renameSandbox: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SandboxApi()
body =  # RenameSandboxRequest | new sandbox name
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

try: 
    # Rename a sandbox
    api_instance.rename_sandbox(body, sandbox)
except ApiException as e:
    print("Exception when calling SandboxApi->renameSandbox: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


updateSandbox

Update sandbox

Update existing sandbox.


/sandboxes/{sandbox}

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/sandboxes/{sandbox}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SandboxApi;

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

public class SandboxApiExample {

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


        SandboxApi apiInstance = new SandboxApi();
        UpdateSandboxRequest body = ; // UpdateSandboxRequest | sandbox properties to update
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            Sandbox result = apiInstance.updateSandbox(body, sandbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#updateSandbox");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SandboxApi;

public class SandboxApiExample {

    public static void main(String[] args) {
        SandboxApi apiInstance = new SandboxApi();
        UpdateSandboxRequest body = ; // UpdateSandboxRequest | sandbox properties to update
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        try {
            Sandbox result = apiInstance.updateSandbox(body, sandbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SandboxApi#updateSandbox");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
UpdateSandboxRequest *body = ; // sandbox properties to update
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'

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

// Update sandbox
[apiInstance updateSandboxWith:body
    sandbox:sandbox
              completionHandler: ^(Sandbox output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.SandboxApi()
var body = ; // {{UpdateSandboxRequest}} sandbox properties to update
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'

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

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

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

            var apiInstance = new SandboxApi();
            var body = new UpdateSandboxRequest(); // UpdateSandboxRequest | sandbox properties to update
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

            try
            {
                // Update sandbox
                Sandbox result = apiInstance.updateSandbox(body, sandbox);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SandboxApi.updateSandbox: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiSandboxApi();
$body = ; // UpdateSandboxRequest | sandbox properties to update
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SandboxApi->new();
my $body = WWW::SwaggerClient::Object::UpdateSandboxRequest->new(); # UpdateSandboxRequest | sandbox properties to update
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

eval { 
    my $result = $api_instance->updateSandbox(body => $body, sandbox => $sandbox);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SandboxApi->updateSandbox: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SandboxApi()
body =  # UpdateSandboxRequest | sandbox properties to update
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'

try: 
    # Update sandbox
    api_response = api_instance.update_sandbox(body, sandbox)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SandboxApi->updateSandbox: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - sandbox successfully updated

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


Schema

createSchema

Create a new schema

Create a new schema. If an initial schema is not provided in the *schema* property, a valid sample schema is created. A schema provided in the *schema* property does not have to validate. The schema type being created must be specified in the type property. The *ArtifactTypeReference.category* property must have a value of *schema*.


/schemas/{sandbox}/{project}

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/schemas/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchemaApi;

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

public class SchemaApiExample {

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


        SchemaApi apiInstance = new SchemaApi();
        CreateSchemaRequest body = ; // CreateSchemaRequest | schema creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createSchema(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#createSchema");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchemaApi;

public class SchemaApiExample {

    public static void main(String[] args) {
        SchemaApi apiInstance = new SchemaApi();
        CreateSchemaRequest body = ; // CreateSchemaRequest | schema creation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.createSchema(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#createSchema");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
CreateSchemaRequest *body = ; // schema creation parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Create a new schema
[apiInstance createSchemaWith:body
    sandbox:sandbox
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.SchemaApi()
var body = ; // {{CreateSchemaRequest}} schema creation parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new SchemaApi();
            var body = new CreateSchemaRequest(); // CreateSchemaRequest | schema creation parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Create a new schema
                apiInstance.createSchema(body, sandbox, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchemaApi.createSchema: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiSchemaApi();
$body = ; // CreateSchemaRequest | schema creation parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try {
    $api_instance->createSchema($body, $sandbox, $project);
} catch (Exception $e) {
    echo 'Exception when calling SchemaApi->createSchema: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchemaApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SchemaApi->new();
my $body = WWW::SwaggerClient::Object::CreateSchemaRequest->new(); # CreateSchemaRequest | schema creation parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    $api_instance->createSchema(body => $body, sandbox => $sandbox, project => $project);
};
if ($@) {
    warn "Exception when calling SchemaApi->createSchema: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SchemaApi()
body =  # CreateSchemaRequest | schema creation parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Create a new schema
    api_instance.create_schema(body, sandbox, project)
except ApiException as e:
    print("Exception when calling SchemaApi->createSchema: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


generateSchema

Generate a schema from a data file

Generate a schema from a data file. Currently only supports generation of a schema from a CSV file. If a non-CSV managed file reference is specified a 501 response is returned. The schema is created in the specified project and is named based on the path. The created schema has passed validation.


/schemas/{sandbox}/{project}/generate

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/schemas/{sandbox}/{project}/generate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchemaApi;

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

public class SchemaApiExample {

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


        SchemaApi apiInstance = new SchemaApi();
        GenerateSchemaRequest body = ; // GenerateSchemaRequest | schema generation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.generateSchema(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#generateSchema");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchemaApi;

public class SchemaApiExample {

    public static void main(String[] args) {
        SchemaApi apiInstance = new SchemaApi();
        GenerateSchemaRequest body = ; // GenerateSchemaRequest | schema generation parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            apiInstance.generateSchema(body, sandbox, project);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#generateSchema");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
GenerateSchemaRequest *body = ; // schema generation parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Generate a schema from a data file
[apiInstance generateSchemaWith:body
    sandbox:sandbox
    project:project
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.SchemaApi()
var body = ; // {{GenerateSchemaRequest}} schema generation parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new SchemaApi();
            var body = new GenerateSchemaRequest(); // GenerateSchemaRequest | schema generation parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Generate a schema from a data file
                apiInstance.generateSchema(body, sandbox, project);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchemaApi.generateSchema: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiSchemaApi();
$body = ; // GenerateSchemaRequest | schema generation parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try {
    $api_instance->generateSchema($body, $sandbox, $project);
} catch (Exception $e) {
    echo 'Exception when calling SchemaApi->generateSchema: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchemaApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SchemaApi->new();
my $body = WWW::SwaggerClient::Object::GenerateSchemaRequest->new(); # GenerateSchemaRequest | schema generation parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    $api_instance->generateSchema(body => $body, sandbox => $sandbox, project => $project);
};
if ($@) {
    warn "Exception when calling SchemaApi->generateSchema: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SchemaApi()
body =  # GenerateSchemaRequest | schema generation parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Generate a schema from a data file
    api_instance.generate_schema(body, sandbox, project)
except ApiException as e:
    print("Exception when calling SchemaApi->generateSchema: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
Body parameters
Name Description
body *

Responses

Status: 201 - resource successfully created

Name Type Format Description
Location String

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - A duplicate resource conflict was detected

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support

Status: 501 - Unsupported data for schema generation


getSchemas

Get all schemas in a project

Get all schemas in a project There is no guarantee that the returned tuple schemas contain a valid JSON schema. Call POST /schemas/{sandbox}/{project}/{schema}/validate to validate the schema.


/schemas/{sandbox}/{project}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/schemas/{sandbox}/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchemaApi;

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

public class SchemaApiExample {

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


        SchemaApi apiInstance = new SchemaApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[TupleSchema] result = apiInstance.getSchemas(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#getSchemas");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchemaApi;

public class SchemaApiExample {

    public static void main(String[] args) {
        SchemaApi apiInstance = new SchemaApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        try {
            array[TupleSchema] result = apiInstance.getSchemas(sandbox, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#getSchemas");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

// Get all schemas in a project
[apiInstance getSchemasWith:sandbox
    project:project
              completionHandler: ^(array[TupleSchema] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.SchemaApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

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

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

            var apiInstance = new SchemaApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

            try
            {
                // Get all schemas in a project
                array[TupleSchema] result = apiInstance.getSchemas(sandbox, project);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchemaApi.getSchemas: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiSchemaApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SchemaApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

eval { 
    my $result = $api_instance->getSchemas(sandbox => $sandbox, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchemaApi->getSchemas: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SchemaApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'

try: 
    # Get all schemas in a project
    api_response = api_instance.get_schemas(sandbox, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchemaApi->getSchemas: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required

Responses

Status: 200 - Schemas in project

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


updateSchema

Update a schema definition

Update a schema. The JSON schema in the schema definition can be replaced as well as the description updated. The JSON schema does not have to be valid.


/schemas/{sandbox}/{project}/{schema}

Usage and SDK Samples

curl -X PUT\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/artifacts/v2/schemas/{sandbox}/{project}/{schema}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchemaApi;

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

public class SchemaApiExample {

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


        SchemaApi apiInstance = new SchemaApi();
        UpdateSchemaRequest body = ; // UpdateSchemaRequest | schema update parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        TupleSchemaReference schema = ; // TupleSchemaReference | schema path encoded as path param of form 'path=\,category=\'
        try {
            TupleSchema result = apiInstance.updateSchema(body, sandbox, project, schema);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#updateSchema");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchemaApi;

public class SchemaApiExample {

    public static void main(String[] args) {
        SchemaApi apiInstance = new SchemaApi();
        UpdateSchemaRequest body = ; // UpdateSchemaRequest | schema update parameters
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        TupleSchemaReference schema = ; // TupleSchemaReference | schema path encoded as path param of form 'path=\,category=\'
        try {
            TupleSchema result = apiInstance.updateSchema(body, sandbox, project, schema);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#updateSchema");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
UpdateSchemaRequest *body = ; // schema update parameters
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
TupleSchemaReference *schema = ; // schema path encoded as path param of form 'path=\,category=\'

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

// Update a schema definition
[apiInstance updateSchemaWith:body
    sandbox:sandbox
    project:project
    schema:schema
              completionHandler: ^(TupleSchema output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.SchemaApi()
var body = ; // {{UpdateSchemaRequest}} schema update parameters
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var schema = ; // {{TupleSchemaReference}} schema path encoded as path param of form 'path=\,category=\'

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

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

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

            var apiInstance = new SchemaApi();
            var body = new UpdateSchemaRequest(); // UpdateSchemaRequest | schema update parameters
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var schema = new TupleSchemaReference(); // TupleSchemaReference | schema path encoded as path param of form 'path=\,category=\'

            try
            {
                // Update a schema definition
                TupleSchema result = apiInstance.updateSchema(body, sandbox, project, schema);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchemaApi.updateSchema: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiSchemaApi();
$body = ; // UpdateSchemaRequest | schema update parameters
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$schema = ; // TupleSchemaReference | schema path encoded as path param of form 'path=\,category=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SchemaApi->new();
my $body = WWW::SwaggerClient::Object::UpdateSchemaRequest->new(); # UpdateSchemaRequest | schema update parameters
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $schema = ; # TupleSchemaReference | schema path encoded as path param of form 'path=\,category=\'

eval { 
    my $result = $api_instance->updateSchema(body => $body, sandbox => $sandbox, project => $project, schema => $schema);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchemaApi->updateSchema: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SchemaApi()
body =  # UpdateSchemaRequest | schema update parameters
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
schema =  # TupleSchemaReference | schema path encoded as path param of form 'path=\,category=\'

try: 
    # Update a schema definition
    api_response = api_instance.update_schema(body, sandbox, project, schema)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchemaApi->updateSchema: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
schema*
TupleSchemaReference
schema path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Updated schema

Status: 400 - Invalid request format or contents

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


validateSchema

Validate schema

Perform schema validation and return the validated schema. Schemas may be modified during validation.


/schemas/{sandbox}/{project}/{schema}/validate

Usage and SDK Samples

curl -X POST\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/schemas/{sandbox}/{project}/{schema}/validate?failOnWarnings="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchemaApi;

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

public class SchemaApiExample {

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


        SchemaApi apiInstance = new SchemaApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        TupleSchemaReference schema = ; // TupleSchemaReference | schema path encoded as path param of form 'path=\,category=\'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            TupleSchema result = apiInstance.validateSchema(sandbox, project, schema, failOnWarnings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#validateSchema");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchemaApi;

public class SchemaApiExample {

    public static void main(String[] args) {
        SchemaApi apiInstance = new SchemaApi();
        SandboxReference sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
        ProjectIdentifier project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
        TupleSchemaReference schema = ; // TupleSchemaReference | schema path encoded as path param of form 'path=\,category=\'
        Boolean failOnWarnings = true; // Boolean | true to fail validation on warnings
        try {
            TupleSchema result = apiInstance.validateSchema(sandbox, project, schema, failOnWarnings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#validateSchema");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SandboxReference *sandbox = ; // sandbox name encoded as path param of form 'name=\,createdBy=\'
ProjectIdentifier *project = ; // project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
TupleSchemaReference *schema = ; // schema path encoded as path param of form 'path=\,category=\'
Boolean *failOnWarnings = true; // true to fail validation on warnings (optional) (default to false)

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

// Validate schema
[apiInstance validateSchemaWith:sandbox
    project:project
    schema:schema
    failOnWarnings:failOnWarnings
              completionHandler: ^(TupleSchema output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.SchemaApi()
var sandbox = ; // {{SandboxReference}} sandbox name encoded as path param of form 'name=\,createdBy=\'
var project = ; // {{ProjectIdentifier}} project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
var schema = ; // {{TupleSchemaReference}} schema path encoded as path param of form 'path=\,category=\'
var opts = { 
  'failOnWarnings': true // {{Boolean}} true to fail validation on warnings
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateSchema(sandbox, project, schema, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

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

            var apiInstance = new SchemaApi();
            var sandbox = new SandboxReference(); // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
            var project = new ProjectIdentifier(); // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
            var schema = new TupleSchemaReference(); // TupleSchemaReference | schema path encoded as path param of form 'path=\,category=\'
            var failOnWarnings = true;  // Boolean | true to fail validation on warnings (optional)  (default to false)

            try
            {
                // Validate schema
                TupleSchema result = apiInstance.validateSchema(sandbox, project, schema, failOnWarnings);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchemaApi.validateSchema: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiSchemaApi();
$sandbox = ; // SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
$project = ; // ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
$schema = ; // TupleSchemaReference | schema path encoded as path param of form 'path=\,category=\'
$failOnWarnings = true; // Boolean | true to fail validation on warnings

try {
    $result = $api_instance->validateSchema($sandbox, $project, $schema, $failOnWarnings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchemaApi->validateSchema: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchemaApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SchemaApi->new();
my $sandbox = ; # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
my $project = ; # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
my $schema = ; # TupleSchemaReference | schema path encoded as path param of form 'path=\,category=\'
my $failOnWarnings = true; # Boolean | true to fail validation on warnings

eval { 
    my $result = $api_instance->validateSchema(sandbox => $sandbox, project => $project, schema => $schema, failOnWarnings => $failOnWarnings);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchemaApi->validateSchema: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SchemaApi()
sandbox =  # SandboxReference | sandbox name encoded as path param of form 'name=\,createdBy=\'
project =  # ProjectIdentifier | project identifier encoded as path param of form 'groupIdentifier=\,artifactIdentifier=\[,name=\]'
schema =  # TupleSchemaReference | schema path encoded as path param of form 'path=\,category=\'
failOnWarnings = true # Boolean | true to fail validation on warnings (optional) (default to false)

try: 
    # Validate schema
    api_response = api_instance.validate_schema(sandbox, project, schema, failOnWarnings=failOnWarnings)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchemaApi->validateSchema: %s\n" % e)

Parameters

Path parameters
Name Description
sandbox*
SandboxReference
sandbox name encoded as path param of form 'name=\<name\>,createdBy=\<createdBy\>'
Required
project*
ProjectIdentifier
project identifier encoded as path param of form 'groupIdentifier=\<groupIdentifier\>,artifactIdentifier=\<artifactIdentifier\>[,name=\<name\>]'
Required
schema*
TupleSchemaReference
schema path encoded as path param of form 'path=\<relative path\>,category=\<category\>'
Required
Query parameters
Name Description
failOnWarnings
Boolean
true to fail validation on warnings

Responses

Status: 200 - Validated schema

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 409 - Artifact validation failed

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


Topology

getArtifactType

Get artifact type

Get artifact type with icon data


/types/{type}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/types/{type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopologyApi;

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

public class TopologyApiExample {

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


        TopologyApi apiInstance = new TopologyApi();
        ArtifactTypeReference type = ; // ArtifactTypeReference | Artifact type name and category, encoded as path param of form 'name=\,category=\'
        try {
            ArtifactType result = apiInstance.getArtifactType(type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getArtifactType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopologyApi;

public class TopologyApiExample {

    public static void main(String[] args) {
        TopologyApi apiInstance = new TopologyApi();
        ArtifactTypeReference type = ; // ArtifactTypeReference | Artifact type name and category, encoded as path param of form 'name=\,category=\'
        try {
            ArtifactType result = apiInstance.getArtifactType(type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getArtifactType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
ArtifactTypeReference *type = ; // Artifact type name and category, encoded as path param of form 'name=\,category=\'

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

// Get artifact type
[apiInstance getArtifactTypeWith:type
              completionHandler: ^(ArtifactType output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.TopologyApi()
var type = ; // {{ArtifactTypeReference}} Artifact type name and category, encoded as path param of form 'name=\,category=\'

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

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

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

            var apiInstance = new TopologyApi();
            var type = new ArtifactTypeReference(); // ArtifactTypeReference | Artifact type name and category, encoded as path param of form 'name=\,category=\'

            try
            {
                // Get artifact type
                ArtifactType result = apiInstance.getArtifactType(type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopologyApi.getArtifactType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiTopologyApi();
$type = ; // ArtifactTypeReference | Artifact type name and category, encoded as path param of form 'name=\,category=\'

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TopologyApi->new();
my $type = ; # ArtifactTypeReference | Artifact type name and category, encoded as path param of form 'name=\,category=\'

eval { 
    my $result = $api_instance->getArtifactType(type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopologyApi->getArtifactType: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TopologyApi()
type =  # ArtifactTypeReference | Artifact type name and category, encoded as path param of form 'name=\,category=\'

try: 
    # Get artifact type
    api_response = api_instance.get_artifact_type(type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologyApi->getArtifactType: %s\n" % e)

Parameters

Path parameters
Name Description
type*
ArtifactTypeReference
Artifact type name and category, encoded as path param of form 'name=\<artifact type name\>,category=\<artifact type category\>'
Required

Responses

Status: 200 - Artifact types

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getArtifactTypes

Get configured artifact types

Get all currently configured artifact types. No icon data is returned in this call.


/types

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/types"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopologyApi;

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

public class TopologyApiExample {

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


        TopologyApi apiInstance = new TopologyApi();
        try {
            array[ArtifactType] result = apiInstance.getArtifactTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getArtifactTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopologyApi;

public class TopologyApiExample {

    public static void main(String[] args) {
        TopologyApi apiInstance = new TopologyApi();
        try {
            array[ArtifactType] result = apiInstance.getArtifactTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getArtifactTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];

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

// Get configured artifact types
[apiInstance getArtifactTypesWithCompletionHandler: 
              ^(array[ArtifactType] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


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

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

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

            var apiInstance = new TopologyApi();

            try
            {
                // Get configured artifact types
                array[ArtifactType] result = apiInstance.getArtifactTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopologyApi.getArtifactTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

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

eval { 
    my $result = $api_instance->getArtifactTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopologyApi->getArtifactTypes: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

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

try: 
    # Get configured artifact types
    api_response = api_instance.get_artifact_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologyApi->getArtifactTypes: %s\n" % e)

Parameters

Responses

Status: 200 - Artifact types

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


getCluster

Get details on a streaming cluster

Get streaming cluster details. A resource does not exist error is returned if no streaming cluster with specified name exists or user does not have read access.


/streaming/{cluster}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/streaming/{cluster}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopologyApi;

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

public class TopologyApiExample {

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


        TopologyApi apiInstance = new TopologyApi();
        StreamingClusterReference cluster = ; // StreamingClusterReference | cluster name encoded as path param of form 'name=\'
        try {
            StreamingCluster result = apiInstance.getCluster(cluster);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getCluster");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopologyApi;

public class TopologyApiExample {

    public static void main(String[] args) {
        TopologyApi apiInstance = new TopologyApi();
        StreamingClusterReference cluster = ; // StreamingClusterReference | cluster name encoded as path param of form 'name=\'
        try {
            StreamingCluster result = apiInstance.getCluster(cluster);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getCluster");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
StreamingClusterReference *cluster = ; // cluster name encoded as path param of form 'name=\'

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

// Get details on a streaming cluster
[apiInstance getClusterWith:cluster
              completionHandler: ^(StreamingCluster output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.TopologyApi()
var cluster = ; // {{StreamingClusterReference}} cluster name encoded as path param of form 'name=\'

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCluster(cluster, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getClusterExample
    {
        public void main()
        {

            // Configure API key authorization: ApiTokenKey
            Configuration.Default.ApiKey.Add("X-Streaming-Web-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Streaming-Web-API-Token", "Bearer");

            var apiInstance = new TopologyApi();
            var cluster = new StreamingClusterReference(); // StreamingClusterReference | cluster name encoded as path param of form 'name=\'

            try
            {
                // Get details on a streaming cluster
                StreamingCluster result = apiInstance.getCluster(cluster);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopologyApi.getCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiTokenKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Streaming-Web-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Streaming-Web-API-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiTopologyApi();
$cluster = ; // StreamingClusterReference | cluster name encoded as path param of form 'name=\'

try {
    $result = $api_instance->getCluster($cluster);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopologyApi->getCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopologyApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TopologyApi->new();
my $cluster = ; # StreamingClusterReference | cluster name encoded as path param of form 'name=\'

eval { 
    my $result = $api_instance->getCluster(cluster => $cluster);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopologyApi->getCluster: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TopologyApi()
cluster =  # StreamingClusterReference | cluster name encoded as path param of form 'name=\'

try: 
    # Get details on a streaming cluster
    api_response = api_instance.get_cluster(cluster)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologyApi->getCluster: %s\n" % e)

Parameters

Path parameters
Name Description
cluster*
StreamingClusterReference
cluster name encoded as path param of form 'name=\<name\>'
Required

Responses

Status: 200 - Streaming cluster details

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getClusters

Get available streaming clusters

Get all available streaming clusters. Current logged in user must have EXISTS permissions to see a cluster. Cluster details can be accessed using GET /clusters/{cluster}


/streaming

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/streaming"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopologyApi;

import java.io.File;
import java.util.*;

public class TopologyApiExample {

    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");


        TopologyApi apiInstance = new TopologyApi();
        try {
            array[StreamingClusterReference] result = apiInstance.getClusters();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getClusters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopologyApi;

public class TopologyApiExample {

    public static void main(String[] args) {
        TopologyApi apiInstance = new TopologyApi();
        try {
            array[StreamingClusterReference] result = apiInstance.getClusters();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getClusters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];

TopologyApi *apiInstance = [[TopologyApi alloc] init];

// Get available streaming clusters
[apiInstance getClustersWithCompletionHandler: 
              ^(array[StreamingClusterReference] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.TopologyApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getClusters(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getClustersExample
    {
        public void main()
        {

            // Configure API key authorization: ApiTokenKey
            Configuration.Default.ApiKey.Add("X-Streaming-Web-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Streaming-Web-API-Token", "Bearer");

            var apiInstance = new TopologyApi();

            try
            {
                // Get available streaming clusters
                array[StreamingClusterReference] result = apiInstance.getClusters();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopologyApi.getClusters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiTokenKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Streaming-Web-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Streaming-Web-API-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiTopologyApi();

try {
    $result = $api_instance->getClusters();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopologyApi->getClusters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopologyApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TopologyApi->new();

eval { 
    my $result = $api_instance->getClusters();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopologyApi->getClusters: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TopologyApi()

try: 
    # Get available streaming clusters
    api_response = api_instance.get_clusters()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologyApi->getClusters: %s\n" % e)

Parameters

Responses

Status: 200 - Available streaming clusters

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


getEnvironment

Get details on a provisioned environment

Get a provisioned environment details. A resource does not exist error is returned if no environment with specified name exists or user does not have the requested permissions.


/environments/{environment}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/environments/{environment}?permission="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopologyApi;

import java.io.File;
import java.util.*;

public class TopologyApiExample {

    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");


        TopologyApi apiInstance = new TopologyApi();
        EnvironmentReference environment = ; // EnvironmentReference | environment name encoded as path param of form 'name=\'
        EnvironmentPermission permission = ; // EnvironmentPermission | only return environment details if user has the specified permission

        try {
            Environment result = apiInstance.getEnvironment(environment, permission);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getEnvironment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopologyApi;

public class TopologyApiExample {

    public static void main(String[] args) {
        TopologyApi apiInstance = new TopologyApi();
        EnvironmentReference environment = ; // EnvironmentReference | environment name encoded as path param of form 'name=\'
        EnvironmentPermission permission = ; // EnvironmentPermission | only return environment details if user has the specified permission

        try {
            Environment result = apiInstance.getEnvironment(environment, permission);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getEnvironment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
EnvironmentReference *environment = ; // environment name encoded as path param of form 'name=\'
EnvironmentPermission *permission = ; // only return environment details if user has the specified permission
 (optional)

TopologyApi *apiInstance = [[TopologyApi alloc] init];

// Get details on a provisioned environment
[apiInstance getEnvironmentWith:environment
    permission:permission
              completionHandler: ^(Environment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.TopologyApi()
var environment = ; // {{EnvironmentReference}} environment name encoded as path param of form 'name=\'
var opts = { 
  'permission':  // {{EnvironmentPermission}} only return environment details if user has the specified permission

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEnvironment(environment, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEnvironmentExample
    {
        public void main()
        {

            // Configure API key authorization: ApiTokenKey
            Configuration.Default.ApiKey.Add("X-Streaming-Web-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Streaming-Web-API-Token", "Bearer");

            var apiInstance = new TopologyApi();
            var environment = new EnvironmentReference(); // EnvironmentReference | environment name encoded as path param of form 'name=\'
            var permission = new EnvironmentPermission(); // EnvironmentPermission | only return environment details if user has the specified permission
 (optional) 

            try
            {
                // Get details on a provisioned environment
                Environment result = apiInstance.getEnvironment(environment, permission);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopologyApi.getEnvironment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiTokenKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Streaming-Web-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Streaming-Web-API-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiTopologyApi();
$environment = ; // EnvironmentReference | environment name encoded as path param of form 'name=\'
$permission = ; // EnvironmentPermission | only return environment details if user has the specified permission


try {
    $result = $api_instance->getEnvironment($environment, $permission);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopologyApi->getEnvironment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopologyApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TopologyApi->new();
my $environment = ; # EnvironmentReference | environment name encoded as path param of form 'name=\'
my $permission = ; # EnvironmentPermission | only return environment details if user has the specified permission


eval { 
    my $result = $api_instance->getEnvironment(environment => $environment, permission => $permission);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopologyApi->getEnvironment: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TopologyApi()
environment =  # EnvironmentReference | environment name encoded as path param of form 'name=\'
permission =  # EnvironmentPermission | only return environment details if user has the specified permission
 (optional)

try: 
    # Get details on a provisioned environment
    api_response = api_instance.get_environment(environment, permission=permission)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologyApi->getEnvironment: %s\n" % e)

Parameters

Path parameters
Name Description
environment*
EnvironmentReference
environment name encoded as path param of form 'name=\<environment name\>'
Required
Query parameters
Name Description
permission
EnvironmentPermission
only return environment details if user has the specified permission

Responses

Status: 200 - Environment details

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getEnvironments

Get provisioned environments

Get all provisioned environment names. Only environments for which user has permission specified in the permission filter are returned. Details on the environment are accessed using GET /environments/{environment}


/environments

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/environments?permission="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopologyApi;

import java.io.File;
import java.util.*;

public class TopologyApiExample {

    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");


        TopologyApi apiInstance = new TopologyApi();
        EnvironmentPermission permission = ; // EnvironmentPermission | permission filter, only return environments for which user has specified permission

        try {
            array[EnvironmentReference] result = apiInstance.getEnvironments(permission);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getEnvironments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopologyApi;

public class TopologyApiExample {

    public static void main(String[] args) {
        TopologyApi apiInstance = new TopologyApi();
        EnvironmentPermission permission = ; // EnvironmentPermission | permission filter, only return environments for which user has specified permission

        try {
            array[EnvironmentReference] result = apiInstance.getEnvironments(permission);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getEnvironments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
EnvironmentPermission *permission = ; // permission filter, only return environments for which user has specified permission
 (optional)

TopologyApi *apiInstance = [[TopologyApi alloc] init];

// Get provisioned environments
[apiInstance getEnvironmentsWith:permission
              completionHandler: ^(array[EnvironmentReference] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.TopologyApi()
var opts = { 
  'permission':  // {{EnvironmentPermission}} permission filter, only return environments for which user has specified permission

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEnvironments(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEnvironmentsExample
    {
        public void main()
        {

            // Configure API key authorization: ApiTokenKey
            Configuration.Default.ApiKey.Add("X-Streaming-Web-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Streaming-Web-API-Token", "Bearer");

            var apiInstance = new TopologyApi();
            var permission = new EnvironmentPermission(); // EnvironmentPermission | permission filter, only return environments for which user has specified permission
 (optional) 

            try
            {
                // Get provisioned environments
                array[EnvironmentReference] result = apiInstance.getEnvironments(permission);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopologyApi.getEnvironments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiTokenKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Streaming-Web-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Streaming-Web-API-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiTopologyApi();
$permission = ; // EnvironmentPermission | permission filter, only return environments for which user has specified permission


try {
    $result = $api_instance->getEnvironments($permission);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopologyApi->getEnvironments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopologyApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TopologyApi->new();
my $permission = ; # EnvironmentPermission | permission filter, only return environments for which user has specified permission


eval { 
    my $result = $api_instance->getEnvironments(permission => $permission);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopologyApi->getEnvironments: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TopologyApi()
permission =  # EnvironmentPermission | permission filter, only return environments for which user has specified permission
 (optional)

try: 
    # Get provisioned environments
    api_response = api_instance.get_environments(permission=permission)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologyApi->getEnvironments: %s\n" % e)

Parameters

Query parameters
Name Description
permission
EnvironmentPermission
permission filter, only return environments for which user has specified permission

Responses

Status: 200 - Environment details

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


getExtension

Get an extension by name

Get a named extension. This call places "large" (icons, schema resources) data into its returned extension description object.


/extensions/{extension}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/extensions/{extension}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopologyApi;

import java.io.File;
import java.util.*;

public class TopologyApiExample {

    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");


        TopologyApi apiInstance = new TopologyApi();
        ExtensionReference extension = ; // ExtensionReference | extension name encoded as path param of form 'name=\,type=\'
        try {
            SupportedExtensions result = apiInstance.getExtension(extension);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getExtension");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopologyApi;

public class TopologyApiExample {

    public static void main(String[] args) {
        TopologyApi apiInstance = new TopologyApi();
        ExtensionReference extension = ; // ExtensionReference | extension name encoded as path param of form 'name=\,type=\'
        try {
            SupportedExtensions result = apiInstance.getExtension(extension);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getExtension");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
ExtensionReference *extension = ; // extension name encoded as path param of form 'name=\,type=\'

TopologyApi *apiInstance = [[TopologyApi alloc] init];

// Get an extension by name
[apiInstance getExtensionWith:extension
              completionHandler: ^(SupportedExtensions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.TopologyApi()
var extension = ; // {{ExtensionReference}} extension name encoded as path param of form 'name=\,type=\'

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExtension(extension, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExtensionExample
    {
        public void main()
        {

            // Configure API key authorization: ApiTokenKey
            Configuration.Default.ApiKey.Add("X-Streaming-Web-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Streaming-Web-API-Token", "Bearer");

            var apiInstance = new TopologyApi();
            var extension = new ExtensionReference(); // ExtensionReference | extension name encoded as path param of form 'name=\,type=\'

            try
            {
                // Get an extension by name
                SupportedExtensions result = apiInstance.getExtension(extension);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopologyApi.getExtension: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiTokenKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Streaming-Web-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Streaming-Web-API-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiTopologyApi();
$extension = ; // ExtensionReference | extension name encoded as path param of form 'name=\,type=\'

try {
    $result = $api_instance->getExtension($extension);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopologyApi->getExtension: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopologyApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TopologyApi->new();
my $extension = ; # ExtensionReference | extension name encoded as path param of form 'name=\,type=\'

eval { 
    my $result = $api_instance->getExtension(extension => $extension);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopologyApi->getExtension: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TopologyApi()
extension =  # ExtensionReference | extension name encoded as path param of form 'name=\,type=\'

try: 
    # Get an extension by name
    api_response = api_instance.get_extension(extension)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologyApi->getExtension: %s\n" % e)

Parameters

Path parameters
Name Description
extension*
ExtensionReference
extension name encoded as path param of form 'name=\<name\>,type=\<type\>'
Required

Responses

Status: 200 - The desired extension

Status: 401 - Session token is missing or invalid

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getExtensions

Get all available extensions

Get all available extensions. This call does not place "large" data (icons, schema resources) into the returned extension descriptions; those fields are always empty. Use GET /extensions/{extensionName} to retrieve an extension description containing all data fields, including those for large data.


/extensions

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/extensions?type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopologyApi;

import java.io.File;
import java.util.*;

public class TopologyApiExample {

    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");


        TopologyApi apiInstance = new TopologyApi();
        ExtensionType type = ; // ExtensionType | Optional extension type filter to only return extensions
of that type

        try {
            array[SupportedExtensions] result = apiInstance.getExtensions(type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getExtensions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopologyApi;

public class TopologyApiExample {

    public static void main(String[] args) {
        TopologyApi apiInstance = new TopologyApi();
        ExtensionType type = ; // ExtensionType | Optional extension type filter to only return extensions
of that type

        try {
            array[SupportedExtensions] result = apiInstance.getExtensions(type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getExtensions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
ExtensionType *type = ; // Optional extension type filter to only return extensions
of that type
 (optional)

TopologyApi *apiInstance = [[TopologyApi alloc] init];

// Get all available extensions
[apiInstance getExtensionsWith:type
              completionHandler: ^(array[SupportedExtensions] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.TopologyApi()
var opts = { 
  'type':  // {{ExtensionType}} Optional extension type filter to only return extensions
of that type

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExtensions(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getExtensionsExample
    {
        public void main()
        {

            // Configure API key authorization: ApiTokenKey
            Configuration.Default.ApiKey.Add("X-Streaming-Web-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Streaming-Web-API-Token", "Bearer");

            var apiInstance = new TopologyApi();
            var type = new ExtensionType(); // ExtensionType | Optional extension type filter to only return extensions
of that type
 (optional) 

            try
            {
                // Get all available extensions
                array[SupportedExtensions] result = apiInstance.getExtensions(type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopologyApi.getExtensions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiTokenKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Streaming-Web-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Streaming-Web-API-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiTopologyApi();
$type = ; // ExtensionType | Optional extension type filter to only return extensions
of that type


try {
    $result = $api_instance->getExtensions($type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopologyApi->getExtensions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopologyApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TopologyApi->new();
my $type = ; # ExtensionType | Optional extension type filter to only return extensions
of that type


eval { 
    my $result = $api_instance->getExtensions(type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopologyApi->getExtensions: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TopologyApi()
type =  # ExtensionType | Optional extension type filter to only return extensions
of that type
 (optional)

try: 
    # Get all available extensions
    api_response = api_instance.get_extensions(type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologyApi->getExtensions: %s\n" % e)

Parameters

Query parameters
Name Description
type
ExtensionType
Optional extension type filter to only return extensions of that type

Responses

Status: 200 - Available extensions

Status: 401 - Session token is missing or invalid

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support


getResources

Get provisioned resources for an environment

Access provisioned resources for an environment. Currently only supported resources are persistent volume claims. A resource does not exist error is returned if no resource with specified name exists or user does not have read access.


/resources/{resource}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/resources/{resource}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopologyApi;

import java.io.File;
import java.util.*;

public class TopologyApiExample {

    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");


        TopologyApi apiInstance = new TopologyApi();
        Identifier resource = ; // Identifier | resource name filter
        try {
            array[PersistentVolumeClaim] result = apiInstance.getResources(resource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getResources");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopologyApi;

public class TopologyApiExample {

    public static void main(String[] args) {
        TopologyApi apiInstance = new TopologyApi();
        Identifier resource = ; // Identifier | resource name filter
        try {
            array[PersistentVolumeClaim] result = apiInstance.getResources(resource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getResources");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
Identifier *resource = ; // resource name filter

TopologyApi *apiInstance = [[TopologyApi alloc] init];

// Get provisioned resources for an environment
[apiInstance getResourcesWith:resource
              completionHandler: ^(array[PersistentVolumeClaim] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.TopologyApi()
var resource = ; // {{Identifier}} resource name filter

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getResources(resource, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getResourcesExample
    {
        public void main()
        {

            // Configure API key authorization: ApiTokenKey
            Configuration.Default.ApiKey.Add("X-Streaming-Web-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Streaming-Web-API-Token", "Bearer");

            var apiInstance = new TopologyApi();
            var resource = new Identifier(); // Identifier | resource name filter

            try
            {
                // Get provisioned resources for an environment
                array[PersistentVolumeClaim] result = apiInstance.getResources(resource);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopologyApi.getResources: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiTokenKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Streaming-Web-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Streaming-Web-API-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiTopologyApi();
$resource = ; // Identifier | resource name filter

try {
    $result = $api_instance->getResources($resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopologyApi->getResources: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopologyApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TopologyApi->new();
my $resource = ; # Identifier | resource name filter

eval { 
    my $result = $api_instance->getResources(resource => $resource);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopologyApi->getResources: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TopologyApi()
resource =  # Identifier | resource name filter

try: 
    # Get provisioned resources for an environment
    api_response = api_instance.get_resources(resource)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologyApi->getResources: %s\n" % e)

Parameters

Path parameters
Name Description
resource*
Identifier
resource name filter
Required

Responses

Status: 200 - Resource details

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getSpaceProjects

Get projects in a space

Get all projects available from a space A resource does not exist error is returned if no source with specified name exists or user does not have read access.


/spaces/{space}

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/spaces/{space}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopologyApi;

import java.io.File;
import java.util.*;

public class TopologyApiExample {

    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");


        TopologyApi apiInstance = new TopologyApi();
        SpaceReference space = ; // SpaceReference | space name encoded as path param of form 'name=\'
        try {
            array[ProjectSummary] result = apiInstance.getSpaceProjects(space);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getSpaceProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopologyApi;

public class TopologyApiExample {

    public static void main(String[] args) {
        TopologyApi apiInstance = new TopologyApi();
        SpaceReference space = ; // SpaceReference | space name encoded as path param of form 'name=\'
        try {
            array[ProjectSummary] result = apiInstance.getSpaceProjects(space);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getSpaceProjects");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
SpaceReference *space = ; // space name encoded as path param of form 'name=\'

TopologyApi *apiInstance = [[TopologyApi alloc] init];

// Get projects in a space
[apiInstance getSpaceProjectsWith:space
              completionHandler: ^(array[ProjectSummary] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.TopologyApi()
var space = ; // {{SpaceReference}} space name encoded as path param of form 'name=\'

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSpaceProjects(space, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSpaceProjectsExample
    {
        public void main()
        {

            // Configure API key authorization: ApiTokenKey
            Configuration.Default.ApiKey.Add("X-Streaming-Web-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Streaming-Web-API-Token", "Bearer");

            var apiInstance = new TopologyApi();
            var space = new SpaceReference(); // SpaceReference | space name encoded as path param of form 'name=\'

            try
            {
                // Get projects in a space
                array[ProjectSummary] result = apiInstance.getSpaceProjects(space);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopologyApi.getSpaceProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiTokenKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Streaming-Web-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Streaming-Web-API-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiTopologyApi();
$space = ; // SpaceReference | space name encoded as path param of form 'name=\'

try {
    $result = $api_instance->getSpaceProjects($space);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopologyApi->getSpaceProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopologyApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TopologyApi->new();
my $space = ; # SpaceReference | space name encoded as path param of form 'name=\'

eval { 
    my $result = $api_instance->getSpaceProjects(space => $space);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopologyApi->getSpaceProjects: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TopologyApi()
space =  # SpaceReference | space name encoded as path param of form 'name=\'

try: 
    # Get projects in a space
    api_response = api_instance.get_space_projects(space)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologyApi->getSpaceProjects: %s\n" % e)

Parameters

Path parameters
Name Description
space*
SpaceReference
space name encoded as path param of form 'name=\<space name\>'
Required

Responses

Status: 200 - Projects available in space

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 410 - Resource does not exist

Status: 500 - Internal server error, contact support


getSpaces

Get configured spaces

Get configured spaces


/spaces

Usage and SDK Samples

curl -X GET\
-H "X-Streaming-Web-API-Token: [[apiKey]]"\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/artifacts/v2/spaces"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopologyApi;

import java.io.File;
import java.util.*;

public class TopologyApiExample {

    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");


        TopologyApi apiInstance = new TopologyApi();
        try {
            array[Space] result = apiInstance.getSpaces();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getSpaces");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopologyApi;

public class TopologyApiExample {

    public static void main(String[] args) {
        TopologyApi apiInstance = new TopologyApi();
        try {
            array[Space] result = apiInstance.getSpaces();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopologyApi#getSpaces");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiTokenKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Streaming-Web-API-Token"];

TopologyApi *apiInstance = [[TopologyApi alloc] init];

// Get configured spaces
[apiInstance getSpacesWithCompletionHandler: 
              ^(array[Space] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TibcoStreamingWebOpenApiSpecification = require('tibco_streaming_web_open_api_specification');
var defaultClient = TibcoStreamingWebOpenApiSpecification.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-Streaming-Web-API-Token'] = "Token"


var api = new TibcoStreamingWebOpenApiSpecification.TopologyApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSpaces(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSpacesExample
    {
        public void main()
        {

            // Configure API key authorization: ApiTokenKey
            Configuration.Default.ApiKey.Add("X-Streaming-Web-API-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Streaming-Web-API-Token", "Bearer");

            var apiInstance = new TopologyApi();

            try
            {
                // Get configured spaces
                array[Space] result = apiInstance.getSpaces();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopologyApi.getSpaces: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiTokenKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Streaming-Web-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Streaming-Web-API-Token', 'Bearer');

$api_instance = new Swagger\Client\ApiTopologyApi();

try {
    $result = $api_instance->getSpaces();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopologyApi->getSpaces: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopologyApi;

# Configure API key authorization: ApiTokenKey
$WWW::SwaggerClient::Configuration::api_key->{'X-Streaming-Web-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-Streaming-Web-API-Token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TopologyApi->new();

eval { 
    my $result = $api_instance->getSpaces();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopologyApi->getSpaces: $@\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-Streaming-Web-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-Streaming-Web-API-Token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TopologyApi()

try: 
    # Get configured spaces
    api_response = api_instance.get_spaces()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologyApi->getSpaces: %s\n" % e)

Parameters

Responses

Status: 200 - Space details

Status: 401 - Session token is missing or invalid

Status: 403 - Authorization failed for target resource

Status: 406 - Unsupported character set requested

Status: 500 - Internal server error, contact support