Galasa Ecosystem API

AuthenticationAPI

postAuthenticate

Provide a refresh token and get back a JWT for authenticating to a Galasa ecosystem.

/auth

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//auth"

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

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

public class AuthenticationAPIApiExample {

    public static void main(String[] args) {
        
        AuthenticationAPIApi apiInstance = new AuthenticationAPIApi();
        AuthProperties body = ; // AuthProperties | 
        try {
            TokenResponse result = apiInstance.postAuthenticate(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationAPIApi#postAuthenticate");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AuthenticationAPIApi;

public class AuthenticationAPIApiExample {

    public static void main(String[] args) {
        AuthenticationAPIApi apiInstance = new AuthenticationAPIApi();
        AuthProperties body = ; // AuthProperties | 
        try {
            TokenResponse result = apiInstance.postAuthenticate(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationAPIApi#postAuthenticate");
            e.printStackTrace();
        }
    }
}

AuthProperties *body = ; // 

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

// Provide a refresh token and get back a JWT for authenticating to a Galasa ecosystem.
[apiInstance postAuthenticateWith:body
              completionHandler: ^(TokenResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');

var api = new GalasaEcosystemApi.AuthenticationAPIApi()
var body = ; // {{AuthProperties}} 

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

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

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

            var apiInstance = new AuthenticationAPIApi();
            var body = new AuthProperties(); // AuthProperties | 

            try
            {
                // Provide a refresh token and get back a JWT for authenticating to a Galasa ecosystem.
                TokenResponse result = apiInstance.postAuthenticate(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationAPIApi.postAuthenticate: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiAuthenticationAPIApi();
$body = ; // AuthProperties | 

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

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

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

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

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

# create an instance of the API class
api_instance = swagger_client.AuthenticationAPIApi()
body =  # AuthProperties | 

try: 
    # Provide a refresh token and get back a JWT for authenticating to a Galasa ecosystem.
    api_response = api_instance.post_authenticate(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationAPIApi->postAuthenticate: %s\n" % e)

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - Returns a JSON Object containing a JWT

Schema

Status: 500 - Internal Server Error

Schema

BootstrapAPI

getEcosystemBootstrap

Contact the Galasa ecosystem

/bootstrap

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/plain,application/json"\
"//bootstrap"

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

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

public class BootstrapAPIApiExample {

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


        BootstrapAPIApi apiInstance = new BootstrapAPIApi();
        try {
            'String' result = apiInstance.getEcosystemBootstrap();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BootstrapAPIApi#getEcosystemBootstrap");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.BootstrapAPIApi;

public class BootstrapAPIApiExample {

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

Configuration *apiConfig = [Configuration sharedConfig];

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

// Contact the Galasa ecosystem
[apiInstance getEcosystemBootstrapWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


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

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

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


            var apiInstance = new BootstrapAPIApi();

            try
            {
                // Contact the Galasa ecosystem
                'String' result = apiInstance.getEcosystemBootstrap();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BootstrapAPIApi.getEcosystemBootstrap: " + e.Message );
            }
        }
    }
}

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


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

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

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


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

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

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


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

try: 
    # Contact the Galasa ecosystem
    api_response = api_instance.get_ecosystem_bootstrap()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BootstrapAPIApi->getEcosystemBootstrap: %s\n" % e)

Parameters

Responses

Status: 200 - The Galasa ecosystem bootstrap.

Schema

Status: 500 - Error

Schema

ConfigurationPropertyStoreAPI

createCpsProperty

Create a new CPS property

Create a new property with the supplied value in the given Namespace within the Configuration Property Store.

/cps/{namespace}/properties

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/plain,application/json"\
-H "Content-Type: application/json"\
"//cps/{namespace}/properties"

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

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

public class ConfigurationPropertyStoreAPIApiExample {

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


        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        Namespace_properties_body body = ; // Namespace_properties_body | The value of the property being created.
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        try {
            'String' result = apiInstance.createCpsProperty(body, namespace);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#createCpsProperty");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigurationPropertyStoreAPIApi;

public class ConfigurationPropertyStoreAPIApiExample {

    public static void main(String[] args) {
        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        Namespace_properties_body body = ; // Namespace_properties_body | The value of the property being created.
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        try {
            'String' result = apiInstance.createCpsProperty(body, namespace);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#createCpsProperty");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
Namespace_properties_body *body = ; // The value of the property being created.
String *namespace = namespace_example; // Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'


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

// Create a new CPS property
[apiInstance createCpsPropertyWith:body
    namespace:namespace
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ConfigurationPropertyStoreAPIApi()
var body = ; // {{Namespace_properties_body}} The value of the property being created.
var namespace = namespace_example; // {{String}} Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'


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

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

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


            var apiInstance = new ConfigurationPropertyStoreAPIApi();
            var body = new Namespace_properties_body(); // Namespace_properties_body | The value of the property being created.
            var namespace = namespace_example;  // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'


            try
            {
                // Create a new CPS property
                'String' result = apiInstance.createCpsProperty(body, namespace);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationPropertyStoreAPIApi.createCpsProperty: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiConfigurationPropertyStoreAPIApi();
$body = ; // Namespace_properties_body | The value of the property being created.
$namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'


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

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


my $api_instance = WWW::SwaggerClient::ConfigurationPropertyStoreAPIApi->new();
my $body = WWW::SwaggerClient::Object::Namespace_properties_body->new(); # Namespace_properties_body | The value of the property being created.
my $namespace = namespace_example; # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'


eval { 
    my $result = $api_instance->createCpsProperty(body => $body, namespace => $namespace);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationPropertyStoreAPIApi->createCpsProperty: $@\n";
}

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


# create an instance of the API class
api_instance = swagger_client.ConfigurationPropertyStoreAPIApi()
body =  # Namespace_properties_body | The value of the property being created.
namespace = namespace_example # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'


try: 
    # Create a new CPS property
    api_response = api_instance.create_cps_property(body, namespace)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationPropertyStoreAPIApi->createCpsProperty: %s\n" % e)

Parameters

Path parameters

Name	Description
namespace*	String Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9' Required

Body parameters

Name	Description
body *

Responses

deleteCpsProperty

Delete existing CPS property

Delete an existing property in a given namepace in the Configuration Properties Store.

/cps/{namespace}/properties/{propertyName}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/plain,application/json"\
"//cps/{namespace}/properties/{propertyName}"

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

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

public class ConfigurationPropertyStoreAPIApiExample {

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


        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        String propertyName = propertyName_example; // String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        try {
            'String' result = apiInstance.deleteCpsProperty(namespace, propertyName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#deleteCpsProperty");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigurationPropertyStoreAPIApi;

public class ConfigurationPropertyStoreAPIApiExample {

    public static void main(String[] args) {
        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        String propertyName = propertyName_example; // String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        try {
            'String' result = apiInstance.deleteCpsProperty(namespace, propertyName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#deleteCpsProperty");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *namespace = namespace_example; // Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

String *propertyName = propertyName_example; // Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


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

// Delete existing CPS property
[apiInstance deleteCpsPropertyWith:namespace
    propertyName:propertyName
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ConfigurationPropertyStoreAPIApi()
var namespace = namespace_example; // {{String}} Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

var propertyName = propertyName_example; // {{String}} Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCpsProperty(namespace, propertyName, callback);

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

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


            var apiInstance = new ConfigurationPropertyStoreAPIApi();
            var namespace = namespace_example;  // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

            var propertyName = propertyName_example;  // String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


            try
            {
                // Delete existing CPS property
                'String' result = apiInstance.deleteCpsProperty(namespace, propertyName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationPropertyStoreAPIApi.deleteCpsProperty: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiConfigurationPropertyStoreAPIApi();
$namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

$propertyName = propertyName_example; // String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


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

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


my $api_instance = WWW::SwaggerClient::ConfigurationPropertyStoreAPIApi->new();
my $namespace = namespace_example; # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

my $propertyName = propertyName_example; # String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


eval { 
    my $result = $api_instance->deleteCpsProperty(namespace => $namespace, propertyName => $propertyName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationPropertyStoreAPIApi->deleteCpsProperty: $@\n";
}

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


# create an instance of the API class
api_instance = swagger_client.ConfigurationPropertyStoreAPIApi()
namespace = namespace_example # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

propertyName = propertyName_example # String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


try: 
    # Delete existing CPS property
    api_response = api_instance.delete_cps_property(namespace, propertyName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationPropertyStoreAPIApi->deleteCpsProperty: %s\n" % e)

Parameters

Path parameters

Name	Description
namespace*	String Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9' Required
propertyName*	String Property Name. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore) Required

Responses

Status: 200 - Action Message

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 404 - Bad Request

Schema

Status: 500 - Error

Schema

getAllCpsNamespaces

Get all known CPS Namespaces

Returns a list of all Namespaces in the Configuration Property Store

/cps

Usage and SDK Samples

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

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

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

public class ConfigurationPropertyStoreAPIApiExample {

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


        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        try {
            array['String'] result = apiInstance.getAllCpsNamespaces();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#getAllCpsNamespaces");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigurationPropertyStoreAPIApi;

public class ConfigurationPropertyStoreAPIApiExample {

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

Configuration *apiConfig = [Configuration sharedConfig];

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

// Get all known CPS Namespaces
[apiInstance getAllCpsNamespacesWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


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

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

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


            var apiInstance = new ConfigurationPropertyStoreAPIApi();

            try
            {
                // Get all known CPS Namespaces
                array['String'] result = apiInstance.getAllCpsNamespaces();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationPropertyStoreAPIApi.getAllCpsNamespaces: " + e.Message );
            }
        }
    }
}

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


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

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

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


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

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

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


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

try: 
    # Get all known CPS Namespaces
    api_response = api_instance.get_all_cps_namespaces()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationPropertyStoreAPIApi->getAllCpsNamespaces: %s\n" % e)

Parameters

Responses

Status: 200 - Array of CPS Namespaces

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 500 - Internal Server Error

Schema

getCpsNamespaceCascadeProperty

Get cascade CPS property

/cps/namespace/{namespace}/prefix/{prefix}/suffix/{suffix}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//cps/namespace/{namespace}/prefix/{prefix}/suffix/{suffix}?infixes="

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

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

public class ConfigurationPropertyStoreAPIApiExample {

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


        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        String namespace = namespace_example; // String | Property Namespace. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        String prefix = prefix_example; // String | Property Prefix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        String suffix = suffix_example; // String | Property suffix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        array[String] infixes = ; // array[String] | Property infixes. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        try {
            CpsProperty result = apiInstance.getCpsNamespaceCascadeProperty(namespace, prefix, suffix, infixes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#getCpsNamespaceCascadeProperty");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigurationPropertyStoreAPIApi;

public class ConfigurationPropertyStoreAPIApiExample {

    public static void main(String[] args) {
        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        String namespace = namespace_example; // String | Property Namespace. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        String prefix = prefix_example; // String | Property Prefix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        String suffix = suffix_example; // String | Property suffix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        array[String] infixes = ; // array[String] | Property infixes. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        try {
            CpsProperty result = apiInstance.getCpsNamespaceCascadeProperty(namespace, prefix, suffix, infixes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#getCpsNamespaceCascadeProperty");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *namespace = namespace_example; // Property Namespace. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

String *prefix = prefix_example; // Property Prefix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

String *suffix = suffix_example; // Property suffix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

array[String] *infixes = ; // Property infixes. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
 (optional)

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

// Get cascade CPS property
[apiInstance getCpsNamespaceCascadePropertyWith:namespace
    prefix:prefix
    suffix:suffix
    infixes:infixes
              completionHandler: ^(CpsProperty output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ConfigurationPropertyStoreAPIApi()
var namespace = namespace_example; // {{String}} Property Namespace. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

var prefix = prefix_example; // {{String}} Property Prefix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

var suffix = suffix_example; // {{String}} Property suffix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

var opts = { 
  'infixes':  // {{array[String]}} Property infixes. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCpsNamespaceCascadeProperty(namespace, prefix, suffix, opts, callback);

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

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


            var apiInstance = new ConfigurationPropertyStoreAPIApi();
            var namespace = namespace_example;  // String | Property Namespace. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

            var prefix = prefix_example;  // String | Property Prefix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

            var suffix = suffix_example;  // String | Property suffix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

            var infixes = new array[String](); // array[String] | Property infixes. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
 (optional) 

            try
            {
                // Get cascade CPS property
                CpsProperty result = apiInstance.getCpsNamespaceCascadeProperty(namespace, prefix, suffix, infixes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationPropertyStoreAPIApi.getCpsNamespaceCascadeProperty: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiConfigurationPropertyStoreAPIApi();
$namespace = namespace_example; // String | Property Namespace. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

$prefix = prefix_example; // String | Property Prefix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

$suffix = suffix_example; // String | Property suffix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

$infixes = ; // array[String] | Property infixes. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


try {
    $result = $api_instance->getCpsNamespaceCascadeProperty($namespace, $prefix, $suffix, $infixes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationPropertyStoreAPIApi->getCpsNamespaceCascadeProperty: ', $e->getMessage(), PHP_EOL;
}
?>

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


my $api_instance = WWW::SwaggerClient::ConfigurationPropertyStoreAPIApi->new();
my $namespace = namespace_example; # String | Property Namespace. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

my $prefix = prefix_example; # String | Property Prefix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

my $suffix = suffix_example; # String | Property suffix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

my $infixes = []; # array[String] | Property infixes. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


eval { 
    my $result = $api_instance->getCpsNamespaceCascadeProperty(namespace => $namespace, prefix => $prefix, suffix => $suffix, infixes => $infixes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationPropertyStoreAPIApi->getCpsNamespaceCascadeProperty: $@\n";
}

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


# create an instance of the API class
api_instance = swagger_client.ConfigurationPropertyStoreAPIApi()
namespace = namespace_example # String | Property Namespace. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

prefix = prefix_example # String | Property Prefix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

suffix = suffix_example # String | Property suffix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

infixes =  # array[String] | Property infixes. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
 (optional)

try: 
    # Get cascade CPS property
    api_response = api_instance.get_cps_namespace_cascade_property(namespace, prefix, suffix, infixes=infixes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationPropertyStoreAPIApi->getCpsNamespaceCascadeProperty: %s\n" % e)

Parameters

Path parameters

Name	Description
namespace*	String Property Namespace. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9' Required
prefix*	String Property Prefix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore) Required
suffix*	String Property suffix. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore) Required

Query parameters

Name	Description
infixes	array[String] Property infixes. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

Responses

Status: 200 - CPS Property

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 500 - Error

Schema

getCpsNamespaceProperties

Get all properties for a namepace

/cps/namespace/{namespace}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//cps/namespace/{namespace}"

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

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

public class ConfigurationPropertyStoreAPIApiExample {

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


        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        try {
            array[CpsProperty] result = apiInstance.getCpsNamespaceProperties(namespace);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#getCpsNamespaceProperties");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigurationPropertyStoreAPIApi;

public class ConfigurationPropertyStoreAPIApiExample {

    public static void main(String[] args) {
        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        try {
            array[CpsProperty] result = apiInstance.getCpsNamespaceProperties(namespace);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#getCpsNamespaceProperties");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *namespace = namespace_example; // Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'


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

// Get all properties for a namepace
[apiInstance getCpsNamespacePropertiesWith:namespace
              completionHandler: ^(array[CpsProperty] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ConfigurationPropertyStoreAPIApi()
var namespace = namespace_example; // {{String}} Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'


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

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

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


            var apiInstance = new ConfigurationPropertyStoreAPIApi();
            var namespace = namespace_example;  // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'


            try
            {
                // Get all properties for a namepace
                array[CpsProperty] result = apiInstance.getCpsNamespaceProperties(namespace);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationPropertyStoreAPIApi.getCpsNamespaceProperties: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiConfigurationPropertyStoreAPIApi();
$namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'


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

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


my $api_instance = WWW::SwaggerClient::ConfigurationPropertyStoreAPIApi->new();
my $namespace = namespace_example; # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'


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

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


# create an instance of the API class
api_instance = swagger_client.ConfigurationPropertyStoreAPIApi()
namespace = namespace_example # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'


try: 
    # Get all properties for a namepace
    api_response = api_instance.get_cps_namespace_properties(namespace)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationPropertyStoreAPIApi->getCpsNamespaceProperties: %s\n" % e)

Parameters

Path parameters

Name	Description
namespace*	String Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9' Required

Responses

Status: 200 - Array of CPS Properties

Schema

Status: 400 - The namespace/prefix/suffix uses invalid characters or is badly formed.

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 500 - Internal Server Error

Schema

getCpsNamespaces

Get CPS Namespaces

/cps/namespace

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//cps/namespace"

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

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

public class ConfigurationPropertyStoreAPIApiExample {

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


        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        try {
            array['String'] result = apiInstance.getCpsNamespaces();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#getCpsNamespaces");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigurationPropertyStoreAPIApi;

public class ConfigurationPropertyStoreAPIApiExample {

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

Configuration *apiConfig = [Configuration sharedConfig];

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

// Get CPS Namespaces
[apiInstance getCpsNamespacesWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


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

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

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


            var apiInstance = new ConfigurationPropertyStoreAPIApi();

            try
            {
                // Get CPS Namespaces
                array['String'] result = apiInstance.getCpsNamespaces();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationPropertyStoreAPIApi.getCpsNamespaces: " + e.Message );
            }
        }
    }
}

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


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

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

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


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

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

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


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

try: 
    # Get CPS Namespaces
    api_response = api_instance.get_cps_namespaces()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationPropertyStoreAPIApi->getCpsNamespaces: %s\n" % e)

Parameters

Responses

Status: 200 - Array of CPS Namespaces

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 500 - Internal Server Error

Schema

getCpsProperty

Get single CPS property

Returns a property, value pair that matches the full propertyName in the given Namespace within the Configuration Property Store.

/cps/{namespace}/properties/{propertyName}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//cps/{namespace}/properties/{propertyName}"

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

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

public class ConfigurationPropertyStoreAPIApiExample {

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


        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        String propertyName = propertyName_example; // String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        try {
            array[CpsProperty] result = apiInstance.getCpsProperty(namespace, propertyName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#getCpsProperty");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigurationPropertyStoreAPIApi;

public class ConfigurationPropertyStoreAPIApiExample {

    public static void main(String[] args) {
        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        String propertyName = propertyName_example; // String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        try {
            array[CpsProperty] result = apiInstance.getCpsProperty(namespace, propertyName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#getCpsProperty");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *namespace = namespace_example; // Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

String *propertyName = propertyName_example; // Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


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

// Get single CPS property
[apiInstance getCpsPropertyWith:namespace
    propertyName:propertyName
              completionHandler: ^(array[CpsProperty] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ConfigurationPropertyStoreAPIApi()
var namespace = namespace_example; // {{String}} Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

var propertyName = propertyName_example; // {{String}} Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCpsProperty(namespace, propertyName, callback);

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

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


            var apiInstance = new ConfigurationPropertyStoreAPIApi();
            var namespace = namespace_example;  // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

            var propertyName = propertyName_example;  // String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


            try
            {
                // Get single CPS property
                array[CpsProperty] result = apiInstance.getCpsProperty(namespace, propertyName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationPropertyStoreAPIApi.getCpsProperty: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiConfigurationPropertyStoreAPIApi();
$namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

$propertyName = propertyName_example; // String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


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

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


my $api_instance = WWW::SwaggerClient::ConfigurationPropertyStoreAPIApi->new();
my $namespace = namespace_example; # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

my $propertyName = propertyName_example; # String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


eval { 
    my $result = $api_instance->getCpsProperty(namespace => $namespace, propertyName => $propertyName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationPropertyStoreAPIApi->getCpsProperty: $@\n";
}

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


# create an instance of the API class
api_instance = swagger_client.ConfigurationPropertyStoreAPIApi()
namespace = namespace_example # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

propertyName = propertyName_example # String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


try: 
    # Get single CPS property
    api_response = api_instance.get_cps_property(namespace, propertyName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationPropertyStoreAPIApi->getCpsProperty: %s\n" % e)

Parameters

Path parameters

Name	Description
namespace*	String Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9' Required
propertyName*	String Property Name. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore) Required

Responses

Status: 200 - CPS Property

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 404 - Bad Request

Schema

Status: 500 - Error

Schema

putCpsNamespaceProperty

Put new CPS Property

Searches multiple places in the property store for the first property matching the namespace, prefix and suffix, and as many of the leading infix strings as possible. This results in a value which is the most specific, given a sparsely populated hierarchical structure of property names. Over-rides of values (if present) are returned in preference to the normal stored value of a property.

/cps/namespace/{namespace}/property/{property}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//cps/namespace/{namespace}/property/{property}"

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

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

public class ConfigurationPropertyStoreAPIApiExample {

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


        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        CpsProperty body = ; // CpsProperty | 
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        String property = property_example; // String | Property Name.
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        try {
            CpsProperty result = apiInstance.putCpsNamespaceProperty(body, namespace, property);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#putCpsNamespaceProperty");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigurationPropertyStoreAPIApi;

public class ConfigurationPropertyStoreAPIApiExample {

    public static void main(String[] args) {
        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        CpsProperty body = ; // CpsProperty | 
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        String property = property_example; // String | Property Name.
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        try {
            CpsProperty result = apiInstance.putCpsNamespaceProperty(body, namespace, property);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#putCpsNamespaceProperty");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
CpsProperty *body = ; // 
String *namespace = namespace_example; // Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

String *property = property_example; // Property Name.
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


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

// Put new CPS Property
[apiInstance putCpsNamespacePropertyWith:body
    namespace:namespace
    property:property
              completionHandler: ^(CpsProperty output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ConfigurationPropertyStoreAPIApi()
var body = ; // {{CpsProperty}} 
var namespace = namespace_example; // {{String}} Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

var property = property_example; // {{String}} Property Name.
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


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

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

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


            var apiInstance = new ConfigurationPropertyStoreAPIApi();
            var body = new CpsProperty(); // CpsProperty | 
            var namespace = namespace_example;  // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

            var property = property_example;  // String | Property Name.
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


            try
            {
                // Put new CPS Property
                CpsProperty result = apiInstance.putCpsNamespaceProperty(body, namespace, property);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationPropertyStoreAPIApi.putCpsNamespaceProperty: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiConfigurationPropertyStoreAPIApi();
$body = ; // CpsProperty | 
$namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

$property = property_example; // String | Property Name.
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


try {
    $result = $api_instance->putCpsNamespaceProperty($body, $namespace, $property);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationPropertyStoreAPIApi->putCpsNamespaceProperty: ', $e->getMessage(), PHP_EOL;
}
?>

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


my $api_instance = WWW::SwaggerClient::ConfigurationPropertyStoreAPIApi->new();
my $body = WWW::SwaggerClient::Object::CpsProperty->new(); # CpsProperty | 
my $namespace = namespace_example; # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

my $property = property_example; # String | Property Name.
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


eval { 
    my $result = $api_instance->putCpsNamespaceProperty(body => $body, namespace => $namespace, property => $property);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationPropertyStoreAPIApi->putCpsNamespaceProperty: $@\n";
}

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


# create an instance of the API class
api_instance = swagger_client.ConfigurationPropertyStoreAPIApi()
body =  # CpsProperty | 
namespace = namespace_example # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

property = property_example # String | Property Name.
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


try: 
    # Put new CPS Property
    api_response = api_instance.put_cps_namespace_property(body, namespace, property)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationPropertyStoreAPIApi->putCpsNamespaceProperty: %s\n" % e)

Parameters

Path parameters

Name	Description
namespace*	String Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9' Required
property*	String Property Name. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore) Required

Body parameters

Name	Description
body *

Responses

Status: 200 - CPS Property

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 500 - Error

Schema

queryCpsNamespaceProperties

Get all CPS namespace properties

Returns a list of all Properties in the given namespace within the Configuration Property Store

/cps/{namespace}/properties

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//cps/{namespace}/properties?prefix=&suffix=&infix="

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

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

public class ConfigurationPropertyStoreAPIApiExample {

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


        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        String prefix = prefix_example; // String | Property Prefix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        String suffix = suffix_example; // String | Property suffix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        String infix = infix_example; // String | Comma-separated list of Property infixes. The first character of each infix must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        try {
            array[CpsProperty] result = apiInstance.queryCpsNamespaceProperties(namespace, prefix, suffix, infix);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#queryCpsNamespaceProperties");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigurationPropertyStoreAPIApi;

public class ConfigurationPropertyStoreAPIApiExample {

    public static void main(String[] args) {
        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        String prefix = prefix_example; // String | Property Prefix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        String suffix = suffix_example; // String | Property suffix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        String infix = infix_example; // String | Comma-separated list of Property infixes. The first character of each infix must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        try {
            array[CpsProperty] result = apiInstance.queryCpsNamespaceProperties(namespace, prefix, suffix, infix);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#queryCpsNamespaceProperties");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *namespace = namespace_example; // Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

String *prefix = prefix_example; // Property Prefix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
 (optional)
String *suffix = suffix_example; // Property suffix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
 (optional)
String *infix = infix_example; // Comma-separated list of Property infixes. The first character of each infix must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
 (optional)

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

// Get all CPS namespace properties
[apiInstance queryCpsNamespacePropertiesWith:namespace
    prefix:prefix
    suffix:suffix
    infix:infix
              completionHandler: ^(array[CpsProperty] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ConfigurationPropertyStoreAPIApi()
var namespace = namespace_example; // {{String}} Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

var opts = { 
  'prefix': prefix_example, // {{String}} Property Prefix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

  'suffix': suffix_example, // {{String}} Property suffix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

  'infix': infix_example // {{String}} Comma-separated list of Property infixes. The first character of each infix must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryCpsNamespaceProperties(namespace, opts, callback);

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

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


            var apiInstance = new ConfigurationPropertyStoreAPIApi();
            var namespace = namespace_example;  // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

            var prefix = prefix_example;  // String | Property Prefix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
 (optional) 
            var suffix = suffix_example;  // String | Property suffix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
 (optional) 
            var infix = infix_example;  // String | Comma-separated list of Property infixes. The first character of each infix must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
 (optional) 

            try
            {
                // Get all CPS namespace properties
                array[CpsProperty] result = apiInstance.queryCpsNamespaceProperties(namespace, prefix, suffix, infix);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationPropertyStoreAPIApi.queryCpsNamespaceProperties: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiConfigurationPropertyStoreAPIApi();
$namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

$prefix = prefix_example; // String | Property Prefix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

$suffix = suffix_example; // String | Property suffix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

$infix = infix_example; // String | Comma-separated list of Property infixes. The first character of each infix must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


try {
    $result = $api_instance->queryCpsNamespaceProperties($namespace, $prefix, $suffix, $infix);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationPropertyStoreAPIApi->queryCpsNamespaceProperties: ', $e->getMessage(), PHP_EOL;
}
?>

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


my $api_instance = WWW::SwaggerClient::ConfigurationPropertyStoreAPIApi->new();
my $namespace = namespace_example; # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

my $prefix = prefix_example; # String | Property Prefix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

my $suffix = suffix_example; # String | Property suffix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

my $infix = infix_example; # String | Comma-separated list of Property infixes. The first character of each infix must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


eval { 
    my $result = $api_instance->queryCpsNamespaceProperties(namespace => $namespace, prefix => $prefix, suffix => $suffix, infix => $infix);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationPropertyStoreAPIApi->queryCpsNamespaceProperties: $@\n";
}

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


# create an instance of the API class
api_instance = swagger_client.ConfigurationPropertyStoreAPIApi()
namespace = namespace_example # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

prefix = prefix_example # String | Property Prefix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
  and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
 (optional)
suffix = suffix_example # String | Property suffix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
 (optional)
infix = infix_example # String | Comma-separated list of Property infixes. The first character of each infix must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
 (optional)

try: 
    # Get all CPS namespace properties
    api_response = api_instance.query_cps_namespace_properties(namespace, prefix=prefix, suffix=suffix, infix=infix)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationPropertyStoreAPIApi->queryCpsNamespaceProperties: %s\n" % e)

Parameters

Path parameters

Name	Description
namespace*	String Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9' Required

Query parameters

Name	Description
prefix	String Property Prefix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
suffix	String Property suffix. The first character must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)
infix	String Comma-separated list of Property infixes. The first character of each infix must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

Responses

Status: 200 - Array of CPS Properties

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 404 - Bad Request

Schema

Status: 500 - Internal Server Error

Schema

updateCpsProperty

Update existing CPS property

Update an existing property in a given namepace in the Configuration Properties Store.

/cps/{namespace}/properties/{propertyName}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/plain,application/json"\
-H "Content-Type: application/json"\
"//cps/{namespace}/properties/{propertyName}"

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

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

public class ConfigurationPropertyStoreAPIApiExample {

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


        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        String body = ; // String | The value of the property being created.
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        String propertyName = propertyName_example; // String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        try {
            'String' result = apiInstance.updateCpsProperty(body, namespace, propertyName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#updateCpsProperty");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigurationPropertyStoreAPIApi;

public class ConfigurationPropertyStoreAPIApiExample {

    public static void main(String[] args) {
        ConfigurationPropertyStoreAPIApi apiInstance = new ConfigurationPropertyStoreAPIApi();
        String body = ; // String | The value of the property being created.
        String namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

        String propertyName = propertyName_example; // String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)

        try {
            'String' result = apiInstance.updateCpsProperty(body, namespace, propertyName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#updateCpsProperty");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *body = ; // The value of the property being created.
String *namespace = namespace_example; // Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

String *propertyName = propertyName_example; // Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


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

// Update existing CPS property
[apiInstance updateCpsPropertyWith:body
    namespace:namespace
    propertyName:propertyName
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ConfigurationPropertyStoreAPIApi()
var body = ; // {{String}} The value of the property being created.
var namespace = namespace_example; // {{String}} Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

var propertyName = propertyName_example; // {{String}} Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


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

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

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


            var apiInstance = new ConfigurationPropertyStoreAPIApi();
            var body = new String(); // String | The value of the property being created.
            var namespace = namespace_example;  // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

            var propertyName = propertyName_example;  // String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


            try
            {
                // Update existing CPS property
                'String' result = apiInstance.updateCpsProperty(body, namespace, propertyName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationPropertyStoreAPIApi.updateCpsProperty: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiConfigurationPropertyStoreAPIApi();
$body = ; // String | The value of the property being created.
$namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

$propertyName = propertyName_example; // String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


try {
    $result = $api_instance->updateCpsProperty($body, $namespace, $propertyName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationPropertyStoreAPIApi->updateCpsProperty: ', $e->getMessage(), PHP_EOL;
}
?>

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


my $api_instance = WWW::SwaggerClient::ConfigurationPropertyStoreAPIApi->new();
my $body = WWW::SwaggerClient::Object::String->new(); # String | The value of the property being created.
my $namespace = namespace_example; # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

my $propertyName = propertyName_example; # String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


eval { 
    my $result = $api_instance->updateCpsProperty(body => $body, namespace => $namespace, propertyName => $propertyName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationPropertyStoreAPIApi->updateCpsProperty: $@\n";
}

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


# create an instance of the API class
api_instance = swagger_client.ConfigurationPropertyStoreAPIApi()
body =  # String | The value of the property being created.
namespace = namespace_example # String | Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9'

propertyName = propertyName_example # String | Property Name. 
The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges,
and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore)


try: 
    # Update existing CPS property
    api_response = api_instance.update_cps_property(body, namespace, propertyName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationPropertyStoreAPIApi->updateCpsProperty: %s\n" % e)

Parameters

Path parameters

Name	Description
namespace*	String Property Namespace. First character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z' or 'A'-'Z' or '0'-'9' Required
propertyName*	String Property Name. The first character of the namespace must be in the 'a'-'z' or 'A'-'Z' ranges, and following characters can be 'a'-'z', 'A'-'Z', '0'-'9', '.' (period), '-' (dash) or '_' (underscore) Required

Body parameters

Name	Description
body *

Responses

Status: 200 - Action Message

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 404 - Bad Request

Schema

Status: 411 - Content Length Required

Schema

Status: 500 - Error

Schema

ResultArchiveStoreAPI

getRasRequestors

Get all known requestors

/ras/requestors

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//ras/requestors?sort="

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

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

public class ResultArchiveStoreAPIApiExample {

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


        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String sort = sort_example; // String | provides sorting, requestor:asc or requestor:desc
        try {
            Requestors result = apiInstance.getRasRequestors(sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasRequestors");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ResultArchiveStoreAPIApi;

public class ResultArchiveStoreAPIApiExample {

    public static void main(String[] args) {
        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String sort = sort_example; // String | provides sorting, requestor:asc or requestor:desc
        try {
            Requestors result = apiInstance.getRasRequestors(sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasRequestors");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *sort = sort_example; // provides sorting, requestor:asc or requestor:desc (optional)

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

// Get all known requestors
[apiInstance getRasRequestorsWith:sort
              completionHandler: ^(Requestors output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ResultArchiveStoreAPIApi()
var opts = { 
  'sort': sort_example // {{String}} provides sorting, requestor:asc or requestor:desc
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRasRequestors(opts, callback);

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

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


            var apiInstance = new ResultArchiveStoreAPIApi();
            var sort = sort_example;  // String | provides sorting, requestor:asc or requestor:desc (optional) 

            try
            {
                // Get all known requestors
                Requestors result = apiInstance.getRasRequestors(sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResultArchiveStoreAPIApi.getRasRequestors: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiResultArchiveStoreAPIApi();
$sort = sort_example; // String | provides sorting, requestor:asc or requestor:desc

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

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


my $api_instance = WWW::SwaggerClient::ResultArchiveStoreAPIApi->new();
my $sort = sort_example; # String | provides sorting, requestor:asc or requestor:desc

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

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


# create an instance of the API class
api_instance = swagger_client.ResultArchiveStoreAPIApi()
sort = sort_example # String | provides sorting, requestor:asc or requestor:desc (optional)

try: 
    # Get all known requestors
    api_response = api_instance.get_ras_requestors(sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResultArchiveStoreAPIApi->getRasRequestors: %s\n" % e)

Parameters

Query parameters

Name	Description
sort	String provides sorting, requestor:asc or requestor:desc

Responses

Status: 200 - Requestors

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 500 - Error

Schema

getRasResultNames

Get all the known result names

/ras/resultnames

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//ras/resultnames?sort="

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

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

public class ResultArchiveStoreAPIApiExample {

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


        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String sort = sort_example; // String | provides sorting, results:asc or results:desc
        try {
            ResultNames result = apiInstance.getRasResultNames(sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasResultNames");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ResultArchiveStoreAPIApi;

public class ResultArchiveStoreAPIApiExample {

    public static void main(String[] args) {
        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String sort = sort_example; // String | provides sorting, results:asc or results:desc
        try {
            ResultNames result = apiInstance.getRasResultNames(sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasResultNames");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *sort = sort_example; // provides sorting, results:asc or results:desc (optional)

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

// Get all the known result names
[apiInstance getRasResultNamesWith:sort
              completionHandler: ^(ResultNames output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ResultArchiveStoreAPIApi()
var opts = { 
  'sort': sort_example // {{String}} provides sorting, results:asc or results:desc
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRasResultNames(opts, callback);

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

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


            var apiInstance = new ResultArchiveStoreAPIApi();
            var sort = sort_example;  // String | provides sorting, results:asc or results:desc (optional) 

            try
            {
                // Get all the known result names
                ResultNames result = apiInstance.getRasResultNames(sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResultArchiveStoreAPIApi.getRasResultNames: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiResultArchiveStoreAPIApi();
$sort = sort_example; // String | provides sorting, results:asc or results:desc

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

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


my $api_instance = WWW::SwaggerClient::ResultArchiveStoreAPIApi->new();
my $sort = sort_example; # String | provides sorting, results:asc or results:desc

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

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


# create an instance of the API class
api_instance = swagger_client.ResultArchiveStoreAPIApi()
sort = sort_example # String | provides sorting, results:asc or results:desc (optional)

try: 
    # Get all the known result names
    api_response = api_instance.get_ras_result_names(sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResultArchiveStoreAPIApi->getRasResultNames: %s\n" % e)

Parameters

Query parameters

Name	Description
sort	String provides sorting, results:asc or results:desc

Responses

Status: 200 - ResultNames

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 500 - Error

Schema

getRasRunArtifactByPath

Download Artifact for a given runid by artifactPath

/ras/runs/{runid}/files/{artifactPath}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/octet-stream,application/json"\
"//ras/runs/{runid}/files/{artifactPath}"

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

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

public class ResultArchiveStoreAPIApiExample {

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


        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String runid = runid_example; // String | Run Id
        String artifactPath = artifactPath_example; // String | Run Artifact path
        try {
            byte[] result = apiInstance.getRasRunArtifactByPath(runid, artifactPath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasRunArtifactByPath");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ResultArchiveStoreAPIApi;

public class ResultArchiveStoreAPIApiExample {

    public static void main(String[] args) {
        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String runid = runid_example; // String | Run Id
        String artifactPath = artifactPath_example; // String | Run Artifact path
        try {
            byte[] result = apiInstance.getRasRunArtifactByPath(runid, artifactPath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasRunArtifactByPath");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *runid = runid_example; // Run Id
String *artifactPath = artifactPath_example; // Run Artifact path

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

// Download Artifact for a given runid by artifactPath
[apiInstance getRasRunArtifactByPathWith:runid
    artifactPath:artifactPath
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ResultArchiveStoreAPIApi()
var runid = runid_example; // {{String}} Run Id
var artifactPath = artifactPath_example; // {{String}} Run Artifact path

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRasRunArtifactByPath(runid, artifactPath, callback);

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

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


            var apiInstance = new ResultArchiveStoreAPIApi();
            var runid = runid_example;  // String | Run Id
            var artifactPath = artifactPath_example;  // String | Run Artifact path

            try
            {
                // Download Artifact for a given runid by artifactPath
                byte[] result = apiInstance.getRasRunArtifactByPath(runid, artifactPath);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResultArchiveStoreAPIApi.getRasRunArtifactByPath: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiResultArchiveStoreAPIApi();
$runid = runid_example; // String | Run Id
$artifactPath = artifactPath_example; // String | Run Artifact path

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

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


my $api_instance = WWW::SwaggerClient::ResultArchiveStoreAPIApi->new();
my $runid = runid_example; # String | Run Id
my $artifactPath = artifactPath_example; # String | Run Artifact path

eval { 
    my $result = $api_instance->getRasRunArtifactByPath(runid => $runid, artifactPath => $artifactPath);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResultArchiveStoreAPIApi->getRasRunArtifactByPath: $@\n";
}

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


# create an instance of the API class
api_instance = swagger_client.ResultArchiveStoreAPIApi()
runid = runid_example # String | Run Id
artifactPath = artifactPath_example # String | Run Artifact path

try: 
    # Download Artifact for a given runid by artifactPath
    api_response = api_instance.get_ras_run_artifact_by_path(runid, artifactPath)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResultArchiveStoreAPIApi->getRasRunArtifactByPath: %s\n" % e)

Parameters

Path parameters

Name	Description
runid*	String Run Id Required
artifactPath*	String Run Artifact path Required

Responses

Status: 200 - The artifact is made available to read.

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 404 - Not Found

Schema

Status: 500 - Internal Server

Schema

getRasRunArtifactList

Get the available Run artifacts which can be downloaded.

/ras/runs/{runid}/artifacts

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//ras/runs/{runid}/artifacts"

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

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

public class ResultArchiveStoreAPIApiExample {

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


        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String runid = runid_example; // String | Run Id
        try {
            ArtifactIndex result = apiInstance.getRasRunArtifactList(runid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasRunArtifactList");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ResultArchiveStoreAPIApi;

public class ResultArchiveStoreAPIApiExample {

    public static void main(String[] args) {
        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String runid = runid_example; // String | Run Id
        try {
            ArtifactIndex result = apiInstance.getRasRunArtifactList(runid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasRunArtifactList");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *runid = runid_example; // Run Id

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

// Get the available Run artifacts which can be downloaded.
[apiInstance getRasRunArtifactListWith:runid
              completionHandler: ^(ArtifactIndex output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ResultArchiveStoreAPIApi()
var runid = runid_example; // {{String}} Run Id

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

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

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


            var apiInstance = new ResultArchiveStoreAPIApi();
            var runid = runid_example;  // String | Run Id

            try
            {
                // Get the available Run artifacts which can be downloaded.
                ArtifactIndex result = apiInstance.getRasRunArtifactList(runid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResultArchiveStoreAPIApi.getRasRunArtifactList: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiResultArchiveStoreAPIApi();
$runid = runid_example; // String | Run Id

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

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


my $api_instance = WWW::SwaggerClient::ResultArchiveStoreAPIApi->new();
my $runid = runid_example; # String | Run Id

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

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


# create an instance of the API class
api_instance = swagger_client.ResultArchiveStoreAPIApi()
runid = runid_example # String | Run Id

try: 
    # Get the available Run artifacts which can be downloaded.
    api_response = api_instance.get_ras_run_artifact_list(runid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResultArchiveStoreAPIApi->getRasRunArtifactList: %s\n" % e)

Parameters

Path parameters

Name	Description
runid*	String Run Id Required

Responses

Status: 200 - The list of artifacts was returned.

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 404 - Not Found

Schema

Status: 500 - Internal Server Error

Schema

getRasRunById

Get Run by ID

/ras/runs/{runid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//ras/runs/{runid}"

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

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

public class ResultArchiveStoreAPIApiExample {

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


        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String runid = runid_example; // String | Run Id
        try {
            Run result = apiInstance.getRasRunById(runid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasRunById");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ResultArchiveStoreAPIApi;

public class ResultArchiveStoreAPIApiExample {

    public static void main(String[] args) {
        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String runid = runid_example; // String | Run Id
        try {
            Run result = apiInstance.getRasRunById(runid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasRunById");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *runid = runid_example; // Run Id

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

// Get Run by ID
[apiInstance getRasRunByIdWith:runid
              completionHandler: ^(Run output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ResultArchiveStoreAPIApi()
var runid = runid_example; // {{String}} Run Id

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

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

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


            var apiInstance = new ResultArchiveStoreAPIApi();
            var runid = runid_example;  // String | Run Id

            try
            {
                // Get Run by ID
                Run result = apiInstance.getRasRunById(runid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResultArchiveStoreAPIApi.getRasRunById: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiResultArchiveStoreAPIApi();
$runid = runid_example; // String | Run Id

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

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


my $api_instance = WWW::SwaggerClient::ResultArchiveStoreAPIApi->new();
my $runid = runid_example; # String | Run Id

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

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


# create an instance of the API class
api_instance = swagger_client.ResultArchiveStoreAPIApi()
runid = runid_example # String | Run Id

try: 
    # Get Run by ID
    api_response = api_instance.get_ras_run_by_id(runid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResultArchiveStoreAPIApi->getRasRunById: %s\n" % e)

Parameters

Path parameters

Name	Description
runid*	String Run Id Required

Responses

Status: 200 - Run Data

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 500 - Error

Schema

getRasRunLog

Get Run Log

/ras/runs/{runid}/runlog

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/plain,application/json"\
"//ras/runs/{runid}/runlog"

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

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

public class ResultArchiveStoreAPIApiExample {

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


        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String runid = runid_example; // String | Run Id
        try {
            'String' result = apiInstance.getRasRunLog(runid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasRunLog");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ResultArchiveStoreAPIApi;

public class ResultArchiveStoreAPIApiExample {

    public static void main(String[] args) {
        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String runid = runid_example; // String | Run Id
        try {
            'String' result = apiInstance.getRasRunLog(runid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasRunLog");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *runid = runid_example; // Run Id

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

// Get Run Log
[apiInstance getRasRunLogWith:runid
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ResultArchiveStoreAPIApi()
var runid = runid_example; // {{String}} Run Id

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

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

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


            var apiInstance = new ResultArchiveStoreAPIApi();
            var runid = runid_example;  // String | Run Id

            try
            {
                // Get Run Log
                'String' result = apiInstance.getRasRunLog(runid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResultArchiveStoreAPIApi.getRasRunLog: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiResultArchiveStoreAPIApi();
$runid = runid_example; // String | Run Id

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

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


my $api_instance = WWW::SwaggerClient::ResultArchiveStoreAPIApi->new();
my $runid = runid_example; # String | Run Id

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

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


# create an instance of the API class
api_instance = swagger_client.ResultArchiveStoreAPIApi()
runid = runid_example # String | Run Id

try: 
    # Get Run Log
    api_response = api_instance.get_ras_run_log(runid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResultArchiveStoreAPIApi->getRasRunLog: %s\n" % e)

Parameters

Path parameters

Name	Description
runid*	String Run Id Required

Responses

Status: 200 - Run Data

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 500 - Error

Schema

getRasSearchRuns

Get Runs from Query

API endpoint to query the Result Archive Store (RAS) for a (possibly sorted) list of runs based on the given search criteria. The results returned are paginated, in that the number of desired records per page can be set, and if there are more test run records to retrieve, requests can be made for successive pages of results using the same query parameters, but varying the 'page' value. Note: When querying multiple pages of results, tests may complete, or be started between successive calls to this endpoint. When the 'to' field is not used, no timeframe limit is specified in the query, so results retrieved in later pages may contain test runs which were already retrieved in previous pages of the same query critera. Invalid query parameters are ignored. For example: a 'cache-buster' parameter.

/ras/runs

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//ras/runs?sort=&result=&status=&bundle=&requestor=&from=&to=&testname=&page=&size=&runId=&runname="

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

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

public class ResultArchiveStoreAPIApiExample {

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


        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String sort = sort_example; // String | Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.

Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.

You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.

        String result = result_example; // String | Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
Multiple values can be used in the query for example: 'EnvFail,Passed,Failed'.
Values are case insensitive. For example 'PASSED' and 'passED' will both be valid.

        String status = status_example; // String | Test run lifecycle status. Current possibles: 'finished','building','generating','running','rundone','up','started','provstart','ending'. These are not case sensitive.
Multiple values can be used in the query for example: 'finished,running,started'.
Values are case insensitive. For example 'FINISHED' and 'finiSHed' will both be valid.

        String bundle = bundle_example; // String | The name of the OSGi bundle that the desired test run(s) were loaded with.

        String requestor = requestor_example; // String | Name of the test requestor / submitter
        Date from = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that started at a time after this date and time.

The only scenario in which from can be omitted is when a runname has been supplied

        Date to = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.

        String testname = testname_example; // String | The full test name (package + short test name)
        Integer page = 56; // Integer | Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.

        Integer size = 56; // Integer | The number of test results returned within each page.
If omitted, the default value is 100.

        String runId = runId_example; // String | The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.

        String runname = runname_example; // String | The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.

        try {
            RunResults result = apiInstance.getRasSearchRuns(sort, result, status, bundle, requestor, from, to, testname, page, size, runId, runname);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasSearchRuns");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ResultArchiveStoreAPIApi;

public class ResultArchiveStoreAPIApiExample {

    public static void main(String[] args) {
        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String sort = sort_example; // String | Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.

Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.

You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.

        String result = result_example; // String | Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
Multiple values can be used in the query for example: 'EnvFail,Passed,Failed'.
Values are case insensitive. For example 'PASSED' and 'passED' will both be valid.

        String status = status_example; // String | Test run lifecycle status. Current possibles: 'finished','building','generating','running','rundone','up','started','provstart','ending'. These are not case sensitive.
Multiple values can be used in the query for example: 'finished,running,started'.
Values are case insensitive. For example 'FINISHED' and 'finiSHed' will both be valid.

        String bundle = bundle_example; // String | The name of the OSGi bundle that the desired test run(s) were loaded with.

        String requestor = requestor_example; // String | Name of the test requestor / submitter
        Date from = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that started at a time after this date and time.

The only scenario in which from can be omitted is when a runname has been supplied

        Date to = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.

        String testname = testname_example; // String | The full test name (package + short test name)
        Integer page = 56; // Integer | Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.

        Integer size = 56; // Integer | The number of test results returned within each page.
If omitted, the default value is 100.

        String runId = runId_example; // String | The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.

        String runname = runname_example; // String | The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.

        try {
            RunResults result = apiInstance.getRasSearchRuns(sort, result, status, bundle, requestor, from, to, testname, page, size, runId, runname);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasSearchRuns");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *sort = sort_example; // Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.

Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.

You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.

String *result = result_example; // Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
Multiple values can be used in the query for example: 'EnvFail,Passed,Failed'.
Values are case insensitive. For example 'PASSED' and 'passED' will both be valid.
 (optional)
String *status = status_example; // Test run lifecycle status. Current possibles: 'finished','building','generating','running','rundone','up','started','provstart','ending'. These are not case sensitive.
Multiple values can be used in the query for example: 'finished,running,started'.
Values are case insensitive. For example 'FINISHED' and 'finiSHed' will both be valid.
 (optional)
String *bundle = bundle_example; // The name of the OSGi bundle that the desired test run(s) were loaded with.
 (optional)
String *requestor = requestor_example; // Name of the test requestor / submitter (optional)
Date *from = 2013-10-20T19:20:30+01:00; // Retrieve runs that started at a time after this date and time.

The only scenario in which from can be omitted is when a runname has been supplied
 (optional)
Date *to = 2013-10-20T19:20:30+01:00; // Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.
 (optional)
String *testname = testname_example; // The full test name (package + short test name) (optional)
Integer *page = 56; // Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.
 (optional)
Integer *size = 56; // The number of test results returned within each page.
If omitted, the default value is 100.
 (optional)
String *runId = runId_example; // The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.
 (optional)
String *runname = runname_example; // The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.
 (optional)

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

// Get Runs from Query
[apiInstance getRasSearchRunsWith:sort
    result:result
    status:status
    bundle:bundle
    requestor:requestor
    from:from
    to:to
    testname:testname
    page:page
    size:size
    runId:runId
    runname:runname
              completionHandler: ^(RunResults output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ResultArchiveStoreAPIApi()
var sort = sort_example; // {{String}} Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.

Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.

You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.

var opts = { 
  'result': result_example, // {{String}} Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
Multiple values can be used in the query for example: 'EnvFail,Passed,Failed'.
Values are case insensitive. For example 'PASSED' and 'passED' will both be valid.

  'status': status_example, // {{String}} Test run lifecycle status. Current possibles: 'finished','building','generating','running','rundone','up','started','provstart','ending'. These are not case sensitive.
Multiple values can be used in the query for example: 'finished,running,started'.
Values are case insensitive. For example 'FINISHED' and 'finiSHed' will both be valid.

  'bundle': bundle_example, // {{String}} The name of the OSGi bundle that the desired test run(s) were loaded with.

  'requestor': requestor_example, // {{String}} Name of the test requestor / submitter
  'from': 2013-10-20T19:20:30+01:00, // {{Date}} Retrieve runs that started at a time after this date and time.

The only scenario in which from can be omitted is when a runname has been supplied

  'to': 2013-10-20T19:20:30+01:00, // {{Date}} Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.

  'testname': testname_example, // {{String}} The full test name (package + short test name)
  'page': 56, // {{Integer}} Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.

  'size': 56, // {{Integer}} The number of test results returned within each page.
If omitted, the default value is 100.

  'runId': runId_example, // {{String}} The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.

  'runname': runname_example // {{String}} The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.

};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRasSearchRuns(sort, opts, callback);

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

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


            var apiInstance = new ResultArchiveStoreAPIApi();
            var sort = sort_example;  // String | Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.

Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.

You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.

            var result = result_example;  // String | Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
Multiple values can be used in the query for example: 'EnvFail,Passed,Failed'.
Values are case insensitive. For example 'PASSED' and 'passED' will both be valid.
 (optional) 
            var status = status_example;  // String | Test run lifecycle status. Current possibles: 'finished','building','generating','running','rundone','up','started','provstart','ending'. These are not case sensitive.
Multiple values can be used in the query for example: 'finished,running,started'.
Values are case insensitive. For example 'FINISHED' and 'finiSHed' will both be valid.
 (optional) 
            var bundle = bundle_example;  // String | The name of the OSGi bundle that the desired test run(s) were loaded with.
 (optional) 
            var requestor = requestor_example;  // String | Name of the test requestor / submitter (optional) 
            var from = 2013-10-20T19:20:30+01:00;  // Date | Retrieve runs that started at a time after this date and time.

The only scenario in which from can be omitted is when a runname has been supplied
 (optional) 
            var to = 2013-10-20T19:20:30+01:00;  // Date | Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.
 (optional) 
            var testname = testname_example;  // String | The full test name (package + short test name) (optional) 
            var page = 56;  // Integer | Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.
 (optional) 
            var size = 56;  // Integer | The number of test results returned within each page.
If omitted, the default value is 100.
 (optional) 
            var runId = runId_example;  // String | The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.
 (optional) 
            var runname = runname_example;  // String | The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.
 (optional) 

            try
            {
                // Get Runs from Query
                RunResults result = apiInstance.getRasSearchRuns(sort, result, status, bundle, requestor, from, to, testname, page, size, runId, runname);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResultArchiveStoreAPIApi.getRasSearchRuns: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiResultArchiveStoreAPIApi();
$sort = sort_example; // String | Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.

Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.

You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.

$result = result_example; // String | Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
Multiple values can be used in the query for example: 'EnvFail,Passed,Failed'.
Values are case insensitive. For example 'PASSED' and 'passED' will both be valid.

$status = status_example; // String | Test run lifecycle status. Current possibles: 'finished','building','generating','running','rundone','up','started','provstart','ending'. These are not case sensitive.
Multiple values can be used in the query for example: 'finished,running,started'.
Values are case insensitive. For example 'FINISHED' and 'finiSHed' will both be valid.

$bundle = bundle_example; // String | The name of the OSGi bundle that the desired test run(s) were loaded with.

$requestor = requestor_example; // String | Name of the test requestor / submitter
$from = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that started at a time after this date and time.

The only scenario in which from can be omitted is when a runname has been supplied

$to = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.

$testname = testname_example; // String | The full test name (package + short test name)
$page = 56; // Integer | Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.

$size = 56; // Integer | The number of test results returned within each page.
If omitted, the default value is 100.

$runId = runId_example; // String | The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.

$runname = runname_example; // String | The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.


try {
    $result = $api_instance->getRasSearchRuns($sort, $result, $status, $bundle, $requestor, $from, $to, $testname, $page, $size, $runId, $runname);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResultArchiveStoreAPIApi->getRasSearchRuns: ', $e->getMessage(), PHP_EOL;
}
?>

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


my $api_instance = WWW::SwaggerClient::ResultArchiveStoreAPIApi->new();
my $sort = sort_example; # String | Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.

Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.

You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.

my $result = result_example; # String | Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
Multiple values can be used in the query for example: 'EnvFail,Passed,Failed'.
Values are case insensitive. For example 'PASSED' and 'passED' will both be valid.

my $status = status_example; # String | Test run lifecycle status. Current possibles: 'finished','building','generating','running','rundone','up','started','provstart','ending'. These are not case sensitive.
Multiple values can be used in the query for example: 'finished,running,started'.
Values are case insensitive. For example 'FINISHED' and 'finiSHed' will both be valid.

my $bundle = bundle_example; # String | The name of the OSGi bundle that the desired test run(s) were loaded with.

my $requestor = requestor_example; # String | Name of the test requestor / submitter
my $from = 2013-10-20T19:20:30+01:00; # Date | Retrieve runs that started at a time after this date and time.

The only scenario in which from can be omitted is when a runname has been supplied

my $to = 2013-10-20T19:20:30+01:00; # Date | Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.

my $testname = testname_example; # String | The full test name (package + short test name)
my $page = 56; # Integer | Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.

my $size = 56; # Integer | The number of test results returned within each page.
If omitted, the default value is 100.

my $runId = runId_example; # String | The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.

my $runname = runname_example; # String | The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.


eval { 
    my $result = $api_instance->getRasSearchRuns(sort => $sort, result => $result, status => $status, bundle => $bundle, requestor => $requestor, from => $from, to => $to, testname => $testname, page => $page, size => $size, runId => $runId, runname => $runname);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResultArchiveStoreAPIApi->getRasSearchRuns: $@\n";
}

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


# create an instance of the API class
api_instance = swagger_client.ResultArchiveStoreAPIApi()
sort = sort_example # String | Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.

Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.

You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.

result = result_example # String | Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
Multiple values can be used in the query for example: 'EnvFail,Passed,Failed'.
Values are case insensitive. For example 'PASSED' and 'passED' will both be valid.
 (optional)
status = status_example # String | Test run lifecycle status. Current possibles: 'finished','building','generating','running','rundone','up','started','provstart','ending'. These are not case sensitive.
Multiple values can be used in the query for example: 'finished,running,started'.
Values are case insensitive. For example 'FINISHED' and 'finiSHed' will both be valid.
 (optional)
bundle = bundle_example # String | The name of the OSGi bundle that the desired test run(s) were loaded with.
 (optional)
requestor = requestor_example # String | Name of the test requestor / submitter (optional)
from = 2013-10-20T19:20:30+01:00 # Date | Retrieve runs that started at a time after this date and time.

The only scenario in which from can be omitted is when a runname has been supplied
 (optional)
to = 2013-10-20T19:20:30+01:00 # Date | Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.
 (optional)
testname = testname_example # String | The full test name (package + short test name) (optional)
page = 56 # Integer | Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.
 (optional)
size = 56 # Integer | The number of test results returned within each page.
If omitted, the default value is 100.
 (optional)
runId = runId_example # String | The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.
 (optional)
runname = runname_example # String | The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.
 (optional)

try: 
    # Get Runs from Query
    api_response = api_instance.get_ras_search_runs(sort, result=result, status=status, bundle=bundle, requestor=requestor, from=from, to=to, testname=testname, page=page, size=size, runId=runId, runname=runname)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResultArchiveStoreAPIApi->getRasSearchRuns: %s\n" % e)

Parameters

Query parameters

Name	Description
sort*	String Sorts the returned runs based on the sort field. Supports sorting fields 'to','result' and 'testclass'. Use '{FIELD-NAME}:asc' to sort in ascending order. Use '{FIELD-NAME}:desc' to sort in descending order. You can use multiple instances of this query parameter, or specify multiple sort orders using one query parameter, and a comma-separated list of sort orders. Required
result	String Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed' Multiple values can be used in the query for example: 'EnvFail,Passed,Failed'. Values are case insensitive. For example 'PASSED' and 'passED' will both be valid.
status	String Test run lifecycle status. Current possibles: 'finished','building','generating','running','rundone','up','started','provstart','ending'. These are not case sensitive. Multiple values can be used in the query for example: 'finished,running,started'. Values are case insensitive. For example 'FINISHED' and 'finiSHed' will both be valid.
bundle	String The name of the OSGi bundle that the desired test run(s) were loaded with.
requestor	String Name of the test requestor / submitter
from	Date (date-time) Retrieve runs that started at a time after this date and time. The only scenario in which from can be omitted is when a runname has been supplied
to	Date (date-time) Retrieve runs that ended at a date and time prior to this date and time value. If you specify this parameter, only test runs which have completed will be returned. Tests currently in-flight will not be visible.
testname	String The full test name (package + short test name)
page	Integer Causes a specific page in the available results to be returned. The first page is page 1. If omitted, then page 1 is returned.
size	Integer The number of test results returned within each page. If omitted, the default value is 100.
runId	String The ID for a specific test run as seen by the RAS. This number is unique across the system, so using this field you can expect one or zero test runs in the first page.
runname	String The name of the test run for which details will be returned. It will normally be unique, but this is not guaranteed, so you may see multiple results for the same runname under some rare circumstances.

Responses

Status: 200 - Array of Run Objects

Schema

Status: 400 - Bad Request

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 404 - Not Found

Schema

Status: 500 - Internal Server Error

Schema

getRasTestclasses

Get all the known test classes

/ras/testclasses

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//ras/testclasses?sort="

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

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

public class ResultArchiveStoreAPIApiExample {

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


        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String sort = sort_example; // String | Provide Sorting
        try {
            TestClasses result = apiInstance.getRasTestclasses(sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasTestclasses");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ResultArchiveStoreAPIApi;

public class ResultArchiveStoreAPIApiExample {

    public static void main(String[] args) {
        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        String sort = sort_example; // String | Provide Sorting
        try {
            TestClasses result = apiInstance.getRasTestclasses(sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasTestclasses");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *sort = sort_example; // Provide Sorting (optional)

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

// Get all the known test classes
[apiInstance getRasTestclassesWith:sort
              completionHandler: ^(TestClasses output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ResultArchiveStoreAPIApi()
var opts = { 
  'sort': sort_example // {{String}} Provide Sorting
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRasTestclasses(opts, callback);

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

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


            var apiInstance = new ResultArchiveStoreAPIApi();
            var sort = sort_example;  // String | Provide Sorting (optional) 

            try
            {
                // Get all the known test classes
                TestClasses result = apiInstance.getRasTestclasses(sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResultArchiveStoreAPIApi.getRasTestclasses: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiResultArchiveStoreAPIApi();
$sort = sort_example; // String | Provide Sorting

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

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


my $api_instance = WWW::SwaggerClient::ResultArchiveStoreAPIApi->new();
my $sort = sort_example; # String | Provide Sorting

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

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


# create an instance of the API class
api_instance = swagger_client.ResultArchiveStoreAPIApi()
sort = sort_example # String | Provide Sorting (optional)

try: 
    # Get all the known test classes
    api_response = api_instance.get_ras_testclasses(sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResultArchiveStoreAPIApi->getRasTestclasses: %s\n" % e)

Parameters

Query parameters

Name	Description
sort	String Provide Sorting

Responses

Status: 200 - TestClasses

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

Status: 500 - Error

Schema

RunsAPI

getRunsGroup

Get group runs

/runs/{groupId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//runs/{groupId}"

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

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

public class RunsAPIApiExample {

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


        RunsAPIApi apiInstance = new RunsAPIApi();
        String groupId = groupId_example; // String | Run Group ID
        try {
            TestRuns result = apiInstance.getRunsGroup(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RunsAPIApi#getRunsGroup");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.RunsAPIApi;

public class RunsAPIApiExample {

    public static void main(String[] args) {
        RunsAPIApi apiInstance = new RunsAPIApi();
        String groupId = groupId_example; // String | Run Group ID
        try {
            TestRuns result = apiInstance.getRunsGroup(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RunsAPIApi#getRunsGroup");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *groupId = groupId_example; // Run Group ID

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

// Get group runs
[apiInstance getRunsGroupWith:groupId
              completionHandler: ^(TestRuns output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.RunsAPIApi()
var groupId = groupId_example; // {{String}} Run Group ID

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

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

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


            var apiInstance = new RunsAPIApi();
            var groupId = groupId_example;  // String | Run Group ID

            try
            {
                // Get group runs
                TestRuns result = apiInstance.getRunsGroup(groupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RunsAPIApi.getRunsGroup: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiRunsAPIApi();
$groupId = groupId_example; // String | Run Group ID

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

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


my $api_instance = WWW::SwaggerClient::RunsAPIApi->new();
my $groupId = groupId_example; # String | Run Group ID

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

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


# create an instance of the API class
api_instance = swagger_client.RunsAPIApi()
groupId = groupId_example # String | Run Group ID

try: 
    # Get group runs
    api_response = api_instance.get_runs_group(groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RunsAPIApi->getRunsGroup: %s\n" % e)

Parameters

Path parameters

Name	Description
groupId*	String Run Group ID Required

Responses

Status: 200 - Run Info

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

postSubmitTestRuns

Sumbit test runs

/runs/{groupId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//runs/{groupId}"

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

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

public class RunsAPIApiExample {

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


        RunsAPIApi apiInstance = new RunsAPIApi();
        TestRunRequest body = ; // TestRunRequest | 
        String groupId = groupId_example; // String | Run Group ID
        try {
            TestRuns result = apiInstance.postSubmitTestRuns(body, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RunsAPIApi#postSubmitTestRuns");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.RunsAPIApi;

public class RunsAPIApiExample {

    public static void main(String[] args) {
        RunsAPIApi apiInstance = new RunsAPIApi();
        TestRunRequest body = ; // TestRunRequest | 
        String groupId = groupId_example; // String | Run Group ID
        try {
            TestRuns result = apiInstance.postSubmitTestRuns(body, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RunsAPIApi#postSubmitTestRuns");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
TestRunRequest *body = ; // 
String *groupId = groupId_example; // Run Group ID

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

// Sumbit test runs
[apiInstance postSubmitTestRunsWith:body
    groupId:groupId
              completionHandler: ^(TestRuns output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.RunsAPIApi()
var body = ; // {{TestRunRequest}} 
var groupId = groupId_example; // {{String}} Run Group ID

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

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

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


            var apiInstance = new RunsAPIApi();
            var body = new TestRunRequest(); // TestRunRequest | 
            var groupId = groupId_example;  // String | Run Group ID

            try
            {
                // Sumbit test runs
                TestRuns result = apiInstance.postSubmitTestRuns(body, groupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RunsAPIApi.postSubmitTestRuns: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiRunsAPIApi();
$body = ; // TestRunRequest | 
$groupId = groupId_example; // String | Run Group ID

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

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


my $api_instance = WWW::SwaggerClient::RunsAPIApi->new();
my $body = WWW::SwaggerClient::Object::TestRunRequest->new(); # TestRunRequest | 
my $groupId = groupId_example; # String | Run Group ID

eval { 
    my $result = $api_instance->postSubmitTestRuns(body => $body, groupId => $groupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RunsAPIApi->postSubmitTestRuns: $@\n";
}

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


# create an instance of the API class
api_instance = swagger_client.RunsAPIApi()
body =  # TestRunRequest | 
groupId = groupId_example # String | Run Group ID

try: 
    # Sumbit test runs
    api_response = api_instance.post_submit_test_runs(body, groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RunsAPIApi->postSubmitTestRuns: %s\n" % e)

Parameters

Path parameters

Name	Description
groupId*	String Run Group ID Required

Body parameters

Name	Description
body *

Responses

Status: 200 - Test Submitted

Schema

Status: 401 - Unauthorized as valid authentication has not been provided

Schema

WebUIWorklistAPI

addWebuiWorklistRunId

Add RAS runId to Worklist

/webui/worklist

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//webui/worklist?runId="

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

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

public class WebUIWorklistAPIApiExample {

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


        WebUIWorklistAPIApi apiInstance = new WebUIWorklistAPIApi();
        String runId = runId_example; // String | Run ID
        try {
            Worklist result = apiInstance.addWebuiWorklistRunId(runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebUIWorklistAPIApi#addWebuiWorklistRunId");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.WebUIWorklistAPIApi;

public class WebUIWorklistAPIApiExample {

    public static void main(String[] args) {
        WebUIWorklistAPIApi apiInstance = new WebUIWorklistAPIApi();
        String runId = runId_example; // String | Run ID
        try {
            Worklist result = apiInstance.addWebuiWorklistRunId(runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebUIWorklistAPIApi#addWebuiWorklistRunId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *runId = runId_example; // Run ID

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

// Add RAS runId to Worklist
[apiInstance addWebuiWorklistRunIdWith:runId
              completionHandler: ^(Worklist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.WebUIWorklistAPIApi()
var runId = runId_example; // {{String}} Run ID

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

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

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


            var apiInstance = new WebUIWorklistAPIApi();
            var runId = runId_example;  // String | Run ID

            try
            {
                // Add RAS runId to Worklist
                Worklist result = apiInstance.addWebuiWorklistRunId(runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebUIWorklistAPIApi.addWebuiWorklistRunId: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiWebUIWorklistAPIApi();
$runId = runId_example; // String | Run ID

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

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


my $api_instance = WWW::SwaggerClient::WebUIWorklistAPIApi->new();
my $runId = runId_example; # String | Run ID

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

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


# create an instance of the API class
api_instance = swagger_client.WebUIWorklistAPIApi()
runId = runId_example # String | Run ID

try: 
    # Add RAS runId to Worklist
    api_response = api_instance.add_webui_worklist_run_id(runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebUIWorklistAPIApi->addWebuiWorklistRunId: %s\n" % e)

Parameters

Query parameters

Name	Description
runId*	String Run ID Required

Responses

Status: 200 - Run added to Worklist and updated Worklist returned

Schema

Status: 404 - Run not found

Schema

deleteWebuiWorklistRunId

Remove RAS runId from Worklist

/webui/worklist

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//webui/worklist?runId="

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

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

public class WebUIWorklistAPIApiExample {

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


        WebUIWorklistAPIApi apiInstance = new WebUIWorklistAPIApi();
        String runId = runId_example; // String | Run Id
        try {
            Worklist result = apiInstance.deleteWebuiWorklistRunId(runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebUIWorklistAPIApi#deleteWebuiWorklistRunId");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.WebUIWorklistAPIApi;

public class WebUIWorklistAPIApiExample {

    public static void main(String[] args) {
        WebUIWorklistAPIApi apiInstance = new WebUIWorklistAPIApi();
        String runId = runId_example; // String | Run Id
        try {
            Worklist result = apiInstance.deleteWebuiWorklistRunId(runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebUIWorklistAPIApi#deleteWebuiWorklistRunId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *runId = runId_example; // Run Id

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

// Remove RAS runId from Worklist
[apiInstance deleteWebuiWorklistRunIdWith:runId
              completionHandler: ^(Worklist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.WebUIWorklistAPIApi()
var runId = runId_example; // {{String}} Run Id

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

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

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


            var apiInstance = new WebUIWorklistAPIApi();
            var runId = runId_example;  // String | Run Id

            try
            {
                // Remove RAS runId from Worklist
                Worklist result = apiInstance.deleteWebuiWorklistRunId(runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebUIWorklistAPIApi.deleteWebuiWorklistRunId: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiWebUIWorklistAPIApi();
$runId = runId_example; // String | Run Id

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

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


my $api_instance = WWW::SwaggerClient::WebUIWorklistAPIApi->new();
my $runId = runId_example; # String | Run Id

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

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


# create an instance of the API class
api_instance = swagger_client.WebUIWorklistAPIApi()
runId = runId_example # String | Run Id

try: 
    # Remove RAS runId from Worklist
    api_response = api_instance.delete_webui_worklist_run_id(runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebUIWorklistAPIApi->deleteWebuiWorklistRunId: %s\n" % e)

Parameters

Query parameters

Name	Description
runId*	String Run Id Required

Responses

Status: 200 - Run removed from Worklist and updated Worklist returned

Schema

Status: 404 - Run not found

Schema

getWebuiWorklist

Get the users Worklist

/webui/worklist

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//webui/worklist"

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

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

public class WebUIWorklistAPIApiExample {

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


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

import io.swagger.client.api.WebUIWorklistAPIApi;

public class WebUIWorklistAPIApiExample {

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

Configuration *apiConfig = [Configuration sharedConfig];

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

// Get the users Worklist
[apiInstance getWebuiWorklistWithCompletionHandler: 
              ^(Worklist output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


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

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

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


            var apiInstance = new WebUIWorklistAPIApi();

            try
            {
                // Get the users Worklist
                Worklist result = apiInstance.getWebuiWorklist();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebUIWorklistAPIApi.getWebuiWorklist: " + e.Message );
            }
        }
    }
}

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


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

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

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


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

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

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


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

try: 
    # Get the users Worklist
    api_response = api_instance.get_webui_worklist()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebUIWorklistAPIApi->getWebuiWorklist: %s\n" % e)

Galasa Ecosystem API

API and SDK Documentation

AuthenticationAPI

postAuthenticate

Usage and SDK Samples

Parameters

Responses

Status: 200 - Returns a JSON Object containing a JWT

Status: 500 - Internal Server Error

BootstrapAPI

getEcosystemBootstrap

Usage and SDK Samples

Parameters

Responses

Status: 200 - The Galasa ecosystem bootstrap.

Status: 500 - Error

ConfigurationPropertyStoreAPI

createCpsProperty

Usage and SDK Samples

Parameters

Responses

Status: 201 - Action Message

Status: 401 - Unauthorized as valid authentication has not been provided

Status: 404 - Bad Request

Status: 411 - Content Length Required

Status: 500 - Error

deleteCpsProperty

Usage and SDK Samples

Parameters

Responses

Status: 200 - Action Message

Status: 401 - Unauthorized as valid authentication has not been provided

Status: 404 - Bad Request

Status: 500 - Error

getAllCpsNamespaces

Usage and SDK Samples

Parameters

Responses

Status: 200 - Array of CPS Namespaces

Status: 401 - Unauthorized as valid authentication has not been provided

Status: 500 - Internal Server Error

getCpsNamespaceCascadeProperty

Usage and SDK Samples

Parameters

Responses

Status: 200 - CPS Property

Status: 401 - Unauthorized as valid authentication has not been provided

Status: 500 - Error

getCpsNamespaceProperties

Usage and SDK Samples

Parameters

Responses

Status: 200 - Array of CPS Properties

Status: 400 - The namespace/prefix/suffix uses invalid characters or is badly formed.

Status: 401 - Unauthorized as valid authentication has not been provided

Status: 500 - Internal Server Error

getCpsNamespaces

Usage and SDK Samples

Parameters

Responses

Status: 200 - Array of CPS Namespaces

Status: 401 - Unauthorized as valid authentication has not been provided

Status: 500 - Internal Server Error

getCpsProperty

Usage and SDK Samples

Parameters

Responses

Status: 200 - CPS Property

Status: 401 - Unauthorized as valid authentication has not been provided

Status: 404 - Bad Request

Status: 500 - Error

putCpsNamespaceProperty

Usage and SDK Samples

Parameters

Responses

Status: 200 - CPS Property

Status: 401 - Unauthorized as valid authentication has not been provided

Status: 500 - Error

queryCpsNamespaceProperties

Usage and SDK Samples