Galasa Ecosystem API

AuthenticationAPI

getAuthenticate

Redirect to authenticate with an upstream OpenID Connect connector.


/auth

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//auth?client_id=&callback_url="
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();
        String clientId = clientId_example; // String | The ID of the client used to authenticate with the upstream connector.
        String callbackUrl = callbackUrl_example; // String | The URL to return to once the authentication process is complete.
This should be a URL to a client web application.

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            apiInstance.getAuthenticate(clientId, callbackUrl, clientApiVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationAPIApi#getAuthenticate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationAPIApi;

public class AuthenticationAPIApiExample {

    public static void main(String[] args) {
        AuthenticationAPIApi apiInstance = new AuthenticationAPIApi();
        String clientId = clientId_example; // String | The ID of the client used to authenticate with the upstream connector.
        String callbackUrl = callbackUrl_example; // String | The URL to return to once the authentication process is complete.
This should be a URL to a client web application.

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            apiInstance.getAuthenticate(clientId, callbackUrl, clientApiVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationAPIApi#getAuthenticate");
            e.printStackTrace();
        }
    }
}
String *clientId = clientId_example; // The ID of the client used to authenticate with the upstream connector.
String *callbackUrl = callbackUrl_example; // The URL to return to once the authentication process is complete.
This should be a URL to a client web application.

String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Redirect to authenticate with an upstream OpenID Connect connector.
[apiInstance getAuthenticateWith:clientId
    callbackUrl:callbackUrl
    clientApiVersion:clientApiVersion
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GalasaEcosystemApi = require('galasa_ecosystem_api');

var api = new GalasaEcosystemApi.AuthenticationAPIApi()
var clientId = clientId_example; // {{String}} The ID of the client used to authenticate with the upstream connector.
var callbackUrl = callbackUrl_example; // {{String}} The URL to return to once the authentication process is complete.
This should be a URL to a client web application.

var opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getAuthenticate(clientId, callbackUrl, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AuthenticationAPIApi();
            var clientId = clientId_example;  // String | The ID of the client used to authenticate with the upstream connector.
            var callbackUrl = callbackUrl_example;  // String | The URL to return to once the authentication process is complete.
This should be a URL to a client web application.

            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Redirect to authenticate with an upstream OpenID Connect connector.
                apiInstance.getAuthenticate(clientId, callbackUrl, clientApiVersion);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationAPIApi.getAuthenticate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationAPIApi();
$clientId = clientId_example; // String | The ID of the client used to authenticate with the upstream connector.
$callbackUrl = callbackUrl_example; // String | The URL to return to once the authentication process is complete.
This should be a URL to a client web application.

$clientApiVersion = clientApiVersion_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AuthenticationAPIApi->new();
my $clientId = clientId_example; # String | The ID of the client used to authenticate with the upstream connector.
my $callbackUrl = callbackUrl_example; # String | The URL to return to once the authentication process is complete.
This should be a URL to a client web application.

my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    $api_instance->getAuthenticate(clientId => $clientId, callbackUrl => $callbackUrl, clientApiVersion => $clientApiVersion);
};
if ($@) {
    warn "Exception when calling AuthenticationAPIApi->getAuthenticate: $@\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()
clientId = clientId_example # String | The ID of the client used to authenticate with the upstream connector.
callbackUrl = callbackUrl_example # String | The URL to return to once the authentication process is complete.
This should be a URL to a client web application.

clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Redirect to authenticate with an upstream OpenID Connect connector.
    api_instance.get_authenticate(clientId, callbackUrl, clientApiVersion=clientApiVersion)
except ApiException as e:
    print("Exception when calling AuthenticationAPIApi->getAuthenticate: %s\n" % e)

Parameters

Header parameters
Name Description
ClientApiVersion
String
Query parameters
Name Description
client_id*
String
The ID of the client used to authenticate with the upstream connector.
Required
callback_url*
String
The URL to return to once the authentication process is complete. This should be a URL to a client web application.
Required

Responses

Status: 302 - Returns a redirect to authenticate with the configured connector.

Name Type Format Description
location String

Status: 400 - Bad Request

Status: 500 - Internal Server Error


getAuthenticateCallback

Callback endpoint used as part of an OAuth 2.0 authorization code flow, redirects to a callback URL with an authorization code as a query parameter.


/auth/callback

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//auth/callback?code=&state="
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();
        String code = code_example; // String | The authorization code for the current authentication request.
        String state = state_example; // String | The state parameter associated with the current authentication request, used to mitigate CSRF attacks.
        try {
            apiInstance.getAuthenticateCallback(code, state);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationAPIApi#getAuthenticateCallback");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationAPIApi;

public class AuthenticationAPIApiExample {

    public static void main(String[] args) {
        AuthenticationAPIApi apiInstance = new AuthenticationAPIApi();
        String code = code_example; // String | The authorization code for the current authentication request.
        String state = state_example; // String | The state parameter associated with the current authentication request, used to mitigate CSRF attacks.
        try {
            apiInstance.getAuthenticateCallback(code, state);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationAPIApi#getAuthenticateCallback");
            e.printStackTrace();
        }
    }
}
String *code = code_example; // The authorization code for the current authentication request.
String *state = state_example; // The state parameter associated with the current authentication request, used to mitigate CSRF attacks.

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

// Callback endpoint used as part of an OAuth 2.0 authorization code flow, redirects to a callback URL with an authorization code as a query parameter.
[apiInstance getAuthenticateCallbackWith:code
    state:state
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GalasaEcosystemApi = require('galasa_ecosystem_api');

var api = new GalasaEcosystemApi.AuthenticationAPIApi()
var code = code_example; // {{String}} The authorization code for the current authentication request.
var state = state_example; // {{String}} The state parameter associated with the current authentication request, used to mitigate CSRF attacks.

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

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

            var apiInstance = new AuthenticationAPIApi();
            var code = code_example;  // String | The authorization code for the current authentication request.
            var state = state_example;  // String | The state parameter associated with the current authentication request, used to mitigate CSRF attacks.

            try
            {
                // Callback endpoint used as part of an OAuth 2.0 authorization code flow, redirects to a callback URL with an authorization code as a query parameter.
                apiInstance.getAuthenticateCallback(code, state);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationAPIApi.getAuthenticateCallback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationAPIApi();
$code = code_example; // String | The authorization code for the current authentication request.
$state = state_example; // String | The state parameter associated with the current authentication request, used to mitigate CSRF attacks.

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

my $api_instance = WWW::SwaggerClient::AuthenticationAPIApi->new();
my $code = code_example; # String | The authorization code for the current authentication request.
my $state = state_example; # String | The state parameter associated with the current authentication request, used to mitigate CSRF attacks.

eval { 
    $api_instance->getAuthenticateCallback(code => $code, state => $state);
};
if ($@) {
    warn "Exception when calling AuthenticationAPIApi->getAuthenticateCallback: $@\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()
code = code_example # String | The authorization code for the current authentication request.
state = state_example # String | The state parameter associated with the current authentication request, used to mitigate CSRF attacks.

try: 
    # Callback endpoint used as part of an OAuth 2.0 authorization code flow, redirects to a callback URL with an authorization code as a query parameter.
    api_instance.get_authenticate_callback(code, state)
except ApiException as e:
    print("Exception when calling AuthenticationAPIApi->getAuthenticateCallback: %s\n" % e)

Parameters

Query parameters
Name Description
code*
String
The authorization code for the current authentication request.
Required
state*
String
The state parameter associated with the current authentication request, used to mitigate CSRF attacks.
Required

Responses

Status: 302 - Returns a redirect to the callback URL provided in the original /auth request.

Name Type Format Description
location String

Status: 400 - Bad Request


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 | 
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            TokenResponse result = apiInstance.postAuthenticate(body, clientApiVersion);
            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 | 
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            TokenResponse result = apiInstance.postAuthenticate(body, clientApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationAPIApi#postAuthenticate");
            e.printStackTrace();
        }
    }
}
AuthProperties *body = ; // 
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Provide a refresh token and get back a JWT for authenticating to a Galasa ecosystem.
[apiInstance postAuthenticateWith:body
    clientApiVersion:clientApiVersion
              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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postAuthenticate(body, opts, 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 | 
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Provide a refresh token and get back a JWT for authenticating to a Galasa ecosystem.
                TokenResponse result = apiInstance.postAuthenticate(body, clientApiVersion);
                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 | 
$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->postAuthenticate($body, $clientApiVersion);
    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 | 
my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->postAuthenticate(body => $body, clientApiVersion => $clientApiVersion);
    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 | 
clientApiVersion = clientApiVersion_example # String |  (optional)

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

Parameters

Header parameters
Name Description
ClientApiVersion
String
Body parameters
Name Description
body *

Responses

Status: 200 - Returns a JSON Object containing a JWT and refresh token

Status: 400 - Bad Request

Status: 500 - Internal Server Error


postClients

Create a new Dex client to authenticate with.


/auth/clients

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//auth/clients"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AuthenticationAPIApi apiInstance = new AuthenticationAPIApi();
        try {
            DexClient result = apiInstance.postClients();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationAPIApi#postClients");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationAPIApi;

public class AuthenticationAPIApiExample {

    public static void main(String[] args) {
        AuthenticationAPIApi apiInstance = new AuthenticationAPIApi();
        try {
            DexClient result = apiInstance.postClients();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationAPIApi#postClients");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

// Create a new Dex client to authenticate with.
[apiInstance postClientsWithCompletionHandler: 
              ^(DexClient 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.AuthenticationAPIApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postClients(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new AuthenticationAPIApi();

            try
            {
                // Create a new Dex client to authenticate with.
                DexClient result = apiInstance.postClients();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationAPIApi.postClients: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


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

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


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

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

try: 
    # Create a new Dex client to authenticate with.
    api_response = api_instance.post_clients()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationAPIApi->postClients: %s\n" % e)

Parameters

Responses

Status: 201 - Returns a JSON Object containing the created client's ID and secret

Status: 500 - Internal Server Error


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();
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            'String' result = apiInstance.getEcosystemBootstrap(clientApiVersion);
            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();
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            'String' result = apiInstance.getEcosystemBootstrap(clientApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BootstrapAPIApi#getEcosystemBootstrap");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Contact the Galasa ecosystem
[apiInstance getEcosystemBootstrapWith:clientApiVersion
              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.BootstrapAPIApi()
var opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEcosystemBootstrap(opts, 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();
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Contact the Galasa ecosystem
                'String' result = apiInstance.getEcosystemBootstrap(clientApiVersion);
                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();
$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->getEcosystemBootstrap($clientApiVersion);
    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();
my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getEcosystemBootstrap(clientApiVersion => $clientApiVersion);
    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()
clientApiVersion = clientApiVersion_example # String |  (optional)

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

Parameters

Header parameters
Name Description
ClientApiVersion
String

Responses

Status: 200 - The Galasa ecosystem bootstrap.

Status: 500 - Error


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();
        GalasaProperty body = ; // GalasaProperty | 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' range,
and following characters can be 'a'-'z' or '0'-'9'

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            'String' result = apiInstance.createCpsProperty(body, namespace, clientApiVersion);
            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();
        GalasaProperty body = ; // GalasaProperty | 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' range,
and following characters can be 'a'-'z' or '0'-'9'

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            'String' result = apiInstance.createCpsProperty(body, namespace, clientApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#createCpsProperty");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
GalasaProperty *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' range,
and following characters can be 'a'-'z' or '0'-'9'

String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Create a new CPS property
[apiInstance createCpsPropertyWith:body
    namespace:namespace
    clientApiVersion:clientApiVersion
              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 = ; // {{GalasaProperty}} 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' range,
and following characters can be 'a'-'z' or '0'-'9'

var opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCpsProperty(bodynamespace, opts, 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 GalasaProperty(); // GalasaProperty | 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' range,
and following characters can be 'a'-'z' or '0'-'9'

            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Create a new CPS property
                'String' result = apiInstance.createCpsProperty(body, namespace, clientApiVersion);
                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 = ; // GalasaProperty | The value of the property being created.
$namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' range,
and following characters can be 'a'-'z' or '0'-'9'

$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->createCpsProperty($body, $namespace, $clientApiVersion);
    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::GalasaProperty->new(); # GalasaProperty | 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' range,
and following characters can be 'a'-'z' or '0'-'9'

my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->createCpsProperty(body => $body, namespace => $namespace, clientApiVersion => $clientApiVersion);
    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 =  # GalasaProperty | The value of the property being created.
namespace = namespace_example # String | Property Namespace. First character of the namespace must be in the 'a'-'z' range,
and following characters can be 'a'-'z' or '0'-'9'

clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Create a new CPS property
    api_response = api_instance.create_cps_property(body, namespace, clientApiVersion=clientApiVersion)
    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' range, and following characters can be 'a'-'z' or '0'-'9'
Required
Header parameters
Name Description
ClientApiVersion
String
Body parameters
Name Description
body *

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

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' range,
and following characters can be '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)

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            'String' result = apiInstance.deleteCpsProperty(namespace, propertyName, clientApiVersion);
            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' range,
and following characters can be '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)

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            'String' result = apiInstance.deleteCpsProperty(namespace, propertyName, clientApiVersion);
            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' range,
and following characters can be '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)

String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Delete existing CPS property
[apiInstance deleteCpsPropertyWith:namespace
    propertyName:propertyName
    clientApiVersion:clientApiVersion
              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' range,
and following characters can be '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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCpsProperty(namespace, propertyName, opts, 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' range,
and following characters can be '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 clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Delete existing CPS property
                'String' result = apiInstance.deleteCpsProperty(namespace, propertyName, clientApiVersion);
                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' range,
and following characters can be '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)

$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->deleteCpsProperty($namespace, $propertyName, $clientApiVersion);
    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' range,
and following characters can be '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)

my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->deleteCpsProperty(namespace => $namespace, propertyName => $propertyName, clientApiVersion => $clientApiVersion);
    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' range,
and following characters can be '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)

clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Delete existing CPS property
    api_response = api_instance.delete_cps_property(namespace, propertyName, clientApiVersion=clientApiVersion)
    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' range, and following characters can be '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
Header parameters
Name Description
ClientApiVersion
String

Responses

Status: 200 - Action Message

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

Status: 404 - Bad Request

Status: 500 - Error


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();
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            array[Namespace] result = apiInstance.getAllCpsNamespaces(clientApiVersion);
            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();
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            array[Namespace] result = apiInstance.getAllCpsNamespaces(clientApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#getAllCpsNamespaces");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Get all known CPS Namespaces
[apiInstance getAllCpsNamespacesWith:clientApiVersion
              completionHandler: ^(array[Namespace] 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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllCpsNamespaces(opts, 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();
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Get all known CPS Namespaces
                array[Namespace] result = apiInstance.getAllCpsNamespaces(clientApiVersion);
                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();
$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->getAllCpsNamespaces($clientApiVersion);
    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();
my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getAllCpsNamespaces(clientApiVersion => $clientApiVersion);
    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()
clientApiVersion = clientApiVersion_example # String |  (optional)

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

Parameters

Header parameters
Name Description
ClientApiVersion
String

Responses

Status: 200 - Array of CPS Namespaces

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

Status: 500 - Internal Server Error


getCpsNamespaceCascadeProperty

Get cascade CPS property

Searches for a property using namespace, prefix suffix and infixes. Deprecated in v0.31.0. Use the /cps/{namespace}/properties call instead, using the prefix, suffix and infix query parameters, instead of this call. This call will be removed in a future version of this REST API.


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

        String clientApiVersion = clientApiVersion_example; // String | 
        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, clientApiVersion, 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)

        String clientApiVersion = clientApiVersion_example; // String | 
        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, clientApiVersion, 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)

String *clientApiVersion = clientApiVersion_example; //  (optional)
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
    clientApiVersion:clientApiVersion
    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 = { 
  'clientApiVersion': clientApiVersion_example, // {{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)

};
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 clientApiVersion = clientApiVersion_example;  // String |  (optional) 
            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, clientApiVersion, 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)

$clientApiVersion = clientApiVersion_example; // 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 {
    $result = $api_instance->getCpsNamespaceCascadeProperty($namespace, $prefix, $suffix, $clientApiVersion, $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 $clientApiVersion = clientApiVersion_example; # String | 
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, clientApiVersion => $clientApiVersion, 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)

clientApiVersion = clientApiVersion_example # String |  (optional)
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, clientApiVersion=clientApiVersion, 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
Header parameters
Name Description
ClientApiVersion
String
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

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

Status: 500 - Error


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' range,
and following characters can be 'a'-'z' or '0'-'9'

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            array[GalasaProperty] result = apiInstance.getCpsNamespaceProperties(namespace, clientApiVersion);
            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' range,
and following characters can be 'a'-'z' or '0'-'9'

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            array[GalasaProperty] result = apiInstance.getCpsNamespaceProperties(namespace, clientApiVersion);
            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' range,
and following characters can be 'a'-'z' or '0'-'9'

String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Get all properties for a namepace
[apiInstance getCpsNamespacePropertiesWith:namespace
    clientApiVersion:clientApiVersion
              completionHandler: ^(array[GalasaProperty] 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' range,
and following characters can be 'a'-'z' or '0'-'9'

var opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCpsNamespaceProperties(namespace, opts, 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' range,
and following characters can be 'a'-'z' or '0'-'9'

            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Get all properties for a namepace
                array[GalasaProperty] result = apiInstance.getCpsNamespaceProperties(namespace, clientApiVersion);
                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' range,
and following characters can be 'a'-'z' or '0'-'9'

$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->getCpsNamespaceProperties($namespace, $clientApiVersion);
    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' range,
and following characters can be 'a'-'z' or '0'-'9'

my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getCpsNamespaceProperties(namespace => $namespace, clientApiVersion => $clientApiVersion);
    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' range,
and following characters can be 'a'-'z' or '0'-'9'

clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Get all properties for a namepace
    api_response = api_instance.get_cps_namespace_properties(namespace, clientApiVersion=clientApiVersion)
    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' range, and following characters can be 'a'-'z' or '0'-'9'
Required
Header parameters
Name Description
ClientApiVersion
String

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

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();
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            array['String'] result = apiInstance.getCpsNamespaces(clientApiVersion);
            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();
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            array['String'] result = apiInstance.getCpsNamespaces(clientApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#getCpsNamespaces");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Get CPS Namespaces
[apiInstance getCpsNamespacesWith:clientApiVersion
              completionHandler: ^(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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCpsNamespaces(opts, 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();
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Get CPS Namespaces
                array['String'] result = apiInstance.getCpsNamespaces(clientApiVersion);
                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();
$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->getCpsNamespaces($clientApiVersion);
    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();
my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getCpsNamespaces(clientApiVersion => $clientApiVersion);
    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()
clientApiVersion = clientApiVersion_example # String |  (optional)

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

Parameters

Header parameters
Name Description
ClientApiVersion
String

Responses

Status: 200 - Array of CPS Namespaces

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

Status: 500 - Internal Server Error


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' range,
and following characters can be '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)

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            array[GalasaProperty] result = apiInstance.getCpsProperty(namespace, propertyName, clientApiVersion);
            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' range,
and following characters can be '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)

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            array[GalasaProperty] result = apiInstance.getCpsProperty(namespace, propertyName, clientApiVersion);
            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' range,
and following characters can be '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)

String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Get single CPS property
[apiInstance getCpsPropertyWith:namespace
    propertyName:propertyName
    clientApiVersion:clientApiVersion
              completionHandler: ^(array[GalasaProperty] 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' range,
and following characters can be '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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCpsProperty(namespace, propertyName, opts, 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' range,
and following characters can be '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 clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Get single CPS property
                array[GalasaProperty] result = apiInstance.getCpsProperty(namespace, propertyName, clientApiVersion);
                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' range,
and following characters can be '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)

$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->getCpsProperty($namespace, $propertyName, $clientApiVersion);
    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' range,
and following characters can be '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)

my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getCpsProperty(namespace => $namespace, propertyName => $propertyName, clientApiVersion => $clientApiVersion);
    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' range,
and following characters can be '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)

clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Get single CPS property
    api_response = api_instance.get_cps_property(namespace, propertyName, clientApiVersion=clientApiVersion)
    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' range, and following characters can be '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
Header parameters
Name Description
ClientApiVersion
String

Responses

Status: 200 - CPS Property

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

Status: 404 - Bad Request

Status: 500 - Error


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' range,
and following characters can be '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)

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            GalasaProperty result = apiInstance.putCpsNamespaceProperty(body, namespace, property, clientApiVersion);
            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' range,
and following characters can be '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)

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            GalasaProperty result = apiInstance.putCpsNamespaceProperty(body, namespace, property, clientApiVersion);
            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' range,
and following characters can be '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)

String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Put new CPS Property
[apiInstance putCpsNamespacePropertyWith:body
    namespace:namespace
    property:property
    clientApiVersion:clientApiVersion
              completionHandler: ^(GalasaProperty 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' range,
and following characters can be '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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putCpsNamespaceProperty(bodynamespaceproperty, opts, 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' range,
and following characters can be '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 clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Put new CPS Property
                GalasaProperty result = apiInstance.putCpsNamespaceProperty(body, namespace, property, clientApiVersion);
                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' range,
and following characters can be '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)

$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->putCpsNamespaceProperty($body, $namespace, $property, $clientApiVersion);
    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' range,
and following characters can be '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)

my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->putCpsNamespaceProperty(body => $body, namespace => $namespace, property => $property, clientApiVersion => $clientApiVersion);
    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' range,
and following characters can be '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)

clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Put new CPS Property
    api_response = api_instance.put_cps_namespace_property(body, namespace, property, clientApiVersion=clientApiVersion)
    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' range, and following characters can be '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
Header parameters
Name Description
ClientApiVersion
String
Body parameters
Name Description
body *

Responses

Status: 200 - CPS Property

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

Status: 500 - Error


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' range,
and following characters can be 'a'-'z' or '0'-'9'

        String clientApiVersion = clientApiVersion_example; // String | 
        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[GalasaProperty] result = apiInstance.queryCpsNamespaceProperties(namespace, clientApiVersion, 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' range,
and following characters can be 'a'-'z' or '0'-'9'

        String clientApiVersion = clientApiVersion_example; // String | 
        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[GalasaProperty] result = apiInstance.queryCpsNamespaceProperties(namespace, clientApiVersion, 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' range,
and following characters can be 'a'-'z' or '0'-'9'

String *clientApiVersion = clientApiVersion_example; //  (optional)
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
    clientApiVersion:clientApiVersion
    prefix:prefix
    suffix:suffix
    infix:infix
              completionHandler: ^(array[GalasaProperty] 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' range,
and following characters can be 'a'-'z' or '0'-'9'

var opts = { 
  'clientApiVersion': clientApiVersion_example, // {{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)

  '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' range,
and following characters can be 'a'-'z' or '0'-'9'

            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 
            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[GalasaProperty] result = apiInstance.queryCpsNamespaceProperties(namespace, clientApiVersion, 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' range,
and following characters can be 'a'-'z' or '0'-'9'

$clientApiVersion = clientApiVersion_example; // 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)

$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, $clientApiVersion, $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' range,
and following characters can be 'a'-'z' or '0'-'9'

my $clientApiVersion = clientApiVersion_example; # String | 
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, clientApiVersion => $clientApiVersion, 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' range,
and following characters can be 'a'-'z' or '0'-'9'

clientApiVersion = clientApiVersion_example # String |  (optional)
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, clientApiVersion=clientApiVersion, 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' range, and following characters can be 'a'-'z' or '0'-'9'
Required
Header parameters
Name Description
ClientApiVersion
String
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

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

Status: 404 - Bad Request

Status: 500 - Internal Server Error


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();
        GalasaProperty body = ; // GalasaProperty | 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' range,
and following characters can be '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)

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            'String' result = apiInstance.updateCpsProperty(body, namespace, propertyName, clientApiVersion);
            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();
        GalasaProperty body = ; // GalasaProperty | 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' range,
and following characters can be '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)

        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            'String' result = apiInstance.updateCpsProperty(body, namespace, propertyName, clientApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationPropertyStoreAPIApi#updateCpsProperty");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
GalasaProperty *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' range,
and following characters can be '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)

String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Update existing CPS property
[apiInstance updateCpsPropertyWith:body
    namespace:namespace
    propertyName:propertyName
    clientApiVersion:clientApiVersion
              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 = ; // {{GalasaProperty}} 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' range,
and following characters can be '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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCpsProperty(bodynamespacepropertyName, opts, 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 GalasaProperty(); // GalasaProperty | 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' range,
and following characters can be '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 clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Update existing CPS property
                'String' result = apiInstance.updateCpsProperty(body, namespace, propertyName, clientApiVersion);
                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 = ; // GalasaProperty | The value of the property being created.
$namespace = namespace_example; // String | Property Namespace. First character of the namespace must be in the 'a'-'z' range,
and following characters can be '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)

$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->updateCpsProperty($body, $namespace, $propertyName, $clientApiVersion);
    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::GalasaProperty->new(); # GalasaProperty | 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' range,
and following characters can be '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)

my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->updateCpsProperty(body => $body, namespace => $namespace, propertyName => $propertyName, clientApiVersion => $clientApiVersion);
    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 =  # GalasaProperty | The value of the property being created.
namespace = namespace_example # String | Property Namespace. First character of the namespace must be in the 'a'-'z' range,
and following characters can be '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)

clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Update existing CPS property
    api_response = api_instance.update_cps_property(body, namespace, propertyName, clientApiVersion=clientApiVersion)
    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' range, and following characters can be '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
Header parameters
Name Description
ClientApiVersion
String
Body parameters
Name Description
body *

Responses

Status: 200 - Action Message

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

Status: 404 - Bad Request

Status: 411 - Content Length Required

Status: 500 - Error


ResourcesAPI

setEcosystemResources

Upload Resources to the ecosystem

This API endpoint allows multiple resources to be supplied in a single request to delete, create and/or update in the ecosystem.


/resources/

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//resources/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesAPIApi;

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

public class ResourcesAPIApiExample {

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


        ResourcesAPIApi apiInstance = new ResourcesAPIApi();
        Resources body = ; // Resources | 
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            apiInstance.setEcosystemResources(body, clientApiVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesAPIApi#setEcosystemResources");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesAPIApi;

public class ResourcesAPIApiExample {

    public static void main(String[] args) {
        ResourcesAPIApi apiInstance = new ResourcesAPIApi();
        Resources body = ; // Resources | 
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            apiInstance.setEcosystemResources(body, clientApiVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesAPIApi#setEcosystemResources");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Resources *body = ; // 
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Upload Resources to the ecosystem
[apiInstance setEcosystemResourcesWith:body
    clientApiVersion:clientApiVersion
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GalasaEcosystemApi = require('galasa_ecosystem_api');
var defaultClient = GalasaEcosystemApi.ApiClient.instance;


var api = new GalasaEcosystemApi.ResourcesAPIApi()
var body = ; // {{Resources}} 
var opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setEcosystemResources(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ResourcesAPIApi();
            var body = new Resources(); // Resources | 
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Upload Resources to the ecosystem
                apiInstance.setEcosystemResources(body, clientApiVersion);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesAPIApi.setEcosystemResources: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiResourcesAPIApi();
$body = ; // Resources | 
$clientApiVersion = clientApiVersion_example; // String | 

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


my $api_instance = WWW::SwaggerClient::ResourcesAPIApi->new();
my $body = WWW::SwaggerClient::Object::Resources->new(); # Resources | 
my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    $api_instance->setEcosystemResources(body => $body, clientApiVersion => $clientApiVersion);
};
if ($@) {
    warn "Exception when calling ResourcesAPIApi->setEcosystemResources: $@\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.ResourcesAPIApi()
body =  # Resources | 
clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Upload Resources to the ecosystem
    api_instance.set_ecosystem_resources(body, clientApiVersion=clientApiVersion)
except ApiException as e:
    print("Exception when calling ResourcesAPIApi->setEcosystemResources: %s\n" % e)

Parameters

Header parameters
Name Description
ClientApiVersion
String
Body parameters
Name Description
body *

Responses

Status: 200 - Success

Status: 400 - Bad Request

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

Status: 500 - Internal Server Error


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 clientApiVersion = clientApiVersion_example; // String | 
        String sort = sort_example; // String | provides sorting, requestor:asc or requestor:desc
        try {
            Requestors result = apiInstance.getRasRequestors(clientApiVersion, 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 clientApiVersion = clientApiVersion_example; // String | 
        String sort = sort_example; // String | provides sorting, requestor:asc or requestor:desc
        try {
            Requestors result = apiInstance.getRasRequestors(clientApiVersion, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasRequestors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *clientApiVersion = clientApiVersion_example; //  (optional)
String *sort = sort_example; // provides sorting, requestor:asc or requestor:desc (optional)

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

// Get all known requestors
[apiInstance getRasRequestorsWith:clientApiVersion
    sort: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 = { 
  'clientApiVersion': clientApiVersion_example, // {{String}} 
  '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 clientApiVersion = clientApiVersion_example;  // String |  (optional) 
            var sort = sort_example;  // String | provides sorting, requestor:asc or requestor:desc (optional) 

            try
            {
                // Get all known requestors
                Requestors result = apiInstance.getRasRequestors(clientApiVersion, 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();
$clientApiVersion = clientApiVersion_example; // String | 
$sort = sort_example; // String | provides sorting, requestor:asc or requestor:desc

try {
    $result = $api_instance->getRasRequestors($clientApiVersion, $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 $clientApiVersion = clientApiVersion_example; # String | 
my $sort = sort_example; # String | provides sorting, requestor:asc or requestor:desc

eval { 
    my $result = $api_instance->getRasRequestors(clientApiVersion => $clientApiVersion, 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()
clientApiVersion = clientApiVersion_example # String |  (optional)
sort = sort_example # String | provides sorting, requestor:asc or requestor:desc (optional)

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

Parameters

Header parameters
Name Description
ClientApiVersion
String
Query parameters
Name Description
sort
String
provides sorting, requestor:asc or requestor:desc

Responses

Status: 200 - Requestors

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

Status: 500 - Error


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 clientApiVersion = clientApiVersion_example; // String | 
        String sort = sort_example; // String | provides sorting, results:asc or results:desc
        try {
            ResultNames result = apiInstance.getRasResultNames(clientApiVersion, 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 clientApiVersion = clientApiVersion_example; // String | 
        String sort = sort_example; // String | provides sorting, results:asc or results:desc
        try {
            ResultNames result = apiInstance.getRasResultNames(clientApiVersion, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasResultNames");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *clientApiVersion = clientApiVersion_example; //  (optional)
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:clientApiVersion
    sort: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 = { 
  'clientApiVersion': clientApiVersion_example, // {{String}} 
  '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 clientApiVersion = clientApiVersion_example;  // String |  (optional) 
            var sort = sort_example;  // String | provides sorting, results:asc or results:desc (optional) 

            try
            {
                // Get all the known result names
                ResultNames result = apiInstance.getRasResultNames(clientApiVersion, 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();
$clientApiVersion = clientApiVersion_example; // String | 
$sort = sort_example; // String | provides sorting, results:asc or results:desc

try {
    $result = $api_instance->getRasResultNames($clientApiVersion, $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 $clientApiVersion = clientApiVersion_example; # String | 
my $sort = sort_example; # String | provides sorting, results:asc or results:desc

eval { 
    my $result = $api_instance->getRasResultNames(clientApiVersion => $clientApiVersion, 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()
clientApiVersion = clientApiVersion_example # String |  (optional)
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(clientApiVersion=clientApiVersion, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResultArchiveStoreAPIApi->getRasResultNames: %s\n" % e)

Parameters

Header parameters
Name Description
ClientApiVersion
String
Query parameters
Name Description
sort
String
provides sorting, results:asc or results:desc

Responses

Status: 200 - ResultNames

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

Status: 500 - Error


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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            byte[] result = apiInstance.getRasRunArtifactByPath(runid, artifactPath, clientApiVersion);
            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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            byte[] result = apiInstance.getRasRunArtifactByPath(runid, artifactPath, clientApiVersion);
            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
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Download Artifact for a given runid by artifactPath
[apiInstance getRasRunArtifactByPathWith:runid
    artifactPath:artifactPath
    clientApiVersion:clientApiVersion
              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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRasRunArtifactByPath(runid, artifactPath, opts, 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
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Download Artifact for a given runid by artifactPath
                byte[] result = apiInstance.getRasRunArtifactByPath(runid, artifactPath, clientApiVersion);
                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
$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->getRasRunArtifactByPath($runid, $artifactPath, $clientApiVersion);
    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
my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getRasRunArtifactByPath(runid => $runid, artifactPath => $artifactPath, clientApiVersion => $clientApiVersion);
    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
clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Download Artifact for a given runid by artifactPath
    api_response = api_instance.get_ras_run_artifact_by_path(runid, artifactPath, clientApiVersion=clientApiVersion)
    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
Header parameters
Name Description
ClientApiVersion
String

Responses

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

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

Status: 404 - Not Found

Status: 500 - Internal Server


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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            ArtifactIndex result = apiInstance.getRasRunArtifactList(runid, clientApiVersion);
            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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            ArtifactIndex result = apiInstance.getRasRunArtifactList(runid, clientApiVersion);
            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
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Get the available Run artifacts which can be downloaded.
[apiInstance getRasRunArtifactListWith:runid
    clientApiVersion:clientApiVersion
              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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRasRunArtifactList(runid, opts, 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
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Get the available Run artifacts which can be downloaded.
                ArtifactIndex result = apiInstance.getRasRunArtifactList(runid, clientApiVersion);
                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
$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->getRasRunArtifactList($runid, $clientApiVersion);
    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
my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getRasRunArtifactList(runid => $runid, clientApiVersion => $clientApiVersion);
    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
clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Get the available Run artifacts which can be downloaded.
    api_response = api_instance.get_ras_run_artifact_list(runid, clientApiVersion=clientApiVersion)
    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
Header parameters
Name Description
ClientApiVersion
String

Responses

Status: 200 - The list of artifacts was returned.

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

Status: 404 - Not Found

Status: 500 - Internal Server Error


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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            Run result = apiInstance.getRasRunById(runid, clientApiVersion);
            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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            Run result = apiInstance.getRasRunById(runid, clientApiVersion);
            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
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Get Run by ID
[apiInstance getRasRunByIdWith:runid
    clientApiVersion:clientApiVersion
              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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRasRunById(runid, opts, 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
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Get Run by ID
                Run result = apiInstance.getRasRunById(runid, clientApiVersion);
                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
$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->getRasRunById($runid, $clientApiVersion);
    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
my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getRasRunById(runid => $runid, clientApiVersion => $clientApiVersion);
    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
clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Get Run by ID
    api_response = api_instance.get_ras_run_by_id(runid, clientApiVersion=clientApiVersion)
    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
Header parameters
Name Description
ClientApiVersion
String

Responses

Status: 200 - Run Data

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

Status: 500 - Error


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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            'String' result = apiInstance.getRasRunLog(runid, clientApiVersion);
            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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            'String' result = apiInstance.getRasRunLog(runid, clientApiVersion);
            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
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Get Run Log
[apiInstance getRasRunLogWith:runid
    clientApiVersion:clientApiVersion
              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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRasRunLog(runid, opts, 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
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Get Run Log
                'String' result = apiInstance.getRasRunLog(runid, clientApiVersion);
                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
$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->getRasRunLog($runid, $clientApiVersion);
    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
my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getRasRunLog(runid => $runid, clientApiVersion => $clientApiVersion);
    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
clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Get Run Log
    api_response = api_instance.get_ras_run_log(runid, clientApiVersion=clientApiVersion)
    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
Header parameters
Name Description
ClientApiVersion
String

Responses

Status: 200 - Run Data

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

Status: 500 - Error


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 clientApiVersion = clientApiVersion_example; // String | 
        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, clientApiVersion, 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 clientApiVersion = clientApiVersion_example; // String | 
        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, clientApiVersion, 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 *clientApiVersion = clientApiVersion_example; //  (optional)
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
    clientApiVersion:clientApiVersion
    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 = { 
  'clientApiVersion': clientApiVersion_example, // {{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.

  '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 clientApiVersion = clientApiVersion_example;  // String |  (optional) 
            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, clientApiVersion, 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.

$clientApiVersion = clientApiVersion_example; // 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.

$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, $clientApiVersion, $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 $clientApiVersion = clientApiVersion_example; # String | 
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, clientApiVersion => $clientApiVersion, 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.

clientApiVersion = clientApiVersion_example # String |  (optional)
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, clientApiVersion=clientApiVersion, 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

Header parameters
Name Description
ClientApiVersion
String
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

Status: 400 - Bad Request

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

Status: 404 - Not Found

Status: 500 - Internal Server Error


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 clientApiVersion = clientApiVersion_example; // String | 
        String sort = sort_example; // String | Provide Sorting
        try {
            TestClasses result = apiInstance.getRasTestclasses(clientApiVersion, 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 clientApiVersion = clientApiVersion_example; // String | 
        String sort = sort_example; // String | Provide Sorting
        try {
            TestClasses result = apiInstance.getRasTestclasses(clientApiVersion, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasTestclasses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *clientApiVersion = clientApiVersion_example; //  (optional)
String *sort = sort_example; // Provide Sorting (optional)

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

// Get all the known test classes
[apiInstance getRasTestclassesWith:clientApiVersion
    sort: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 = { 
  'clientApiVersion': clientApiVersion_example, // {{String}} 
  '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 clientApiVersion = clientApiVersion_example;  // String |  (optional) 
            var sort = sort_example;  // String | Provide Sorting (optional) 

            try
            {
                // Get all the known test classes
                TestClasses result = apiInstance.getRasTestclasses(clientApiVersion, 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();
$clientApiVersion = clientApiVersion_example; // String | 
$sort = sort_example; // String | Provide Sorting

try {
    $result = $api_instance->getRasTestclasses($clientApiVersion, $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 $clientApiVersion = clientApiVersion_example; # String | 
my $sort = sort_example; # String | Provide Sorting

eval { 
    my $result = $api_instance->getRasTestclasses(clientApiVersion => $clientApiVersion, 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()
clientApiVersion = clientApiVersion_example # String |  (optional)
sort = sort_example # String | Provide Sorting (optional)

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

Parameters

Header parameters
Name Description
ClientApiVersion
String
Query parameters
Name Description
sort
String
Provide Sorting

Responses

Status: 200 - TestClasses

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

Status: 500 - Error


putRasRunStatusById

Update the status of a test run


/ras/runs/{runid}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/plain,application/json"\
-H "Content-Type: 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();
        UpdateRunStatusRequest body = ; // UpdateRunStatusRequest | 
        String runid = runid_example; // String | Run Id
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            'String' result = apiInstance.putRasRunStatusById(body, runid, clientApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#putRasRunStatusById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResultArchiveStoreAPIApi;

public class ResultArchiveStoreAPIApiExample {

    public static void main(String[] args) {
        ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
        UpdateRunStatusRequest body = ; // UpdateRunStatusRequest | 
        String runid = runid_example; // String | Run Id
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            'String' result = apiInstance.putRasRunStatusById(body, runid, clientApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResultArchiveStoreAPIApi#putRasRunStatusById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
UpdateRunStatusRequest *body = ; // 
String *runid = runid_example; // Run Id
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Update the status of a test run
[apiInstance putRasRunStatusByIdWith:body
    runid:runid
    clientApiVersion:clientApiVersion
              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 body = ; // {{UpdateRunStatusRequest}} 
var runid = runid_example; // {{String}} Run Id
var opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putRasRunStatusById(bodyrunid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ResultArchiveStoreAPIApi();
            var body = new UpdateRunStatusRequest(); // UpdateRunStatusRequest | 
            var runid = runid_example;  // String | Run Id
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Update the status of a test run
                'String' result = apiInstance.putRasRunStatusById(body, runid, clientApiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResultArchiveStoreAPIApi.putRasRunStatusById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


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

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


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

eval { 
    my $result = $api_instance->putRasRunStatusById(body => $body, runid => $runid, clientApiVersion => $clientApiVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResultArchiveStoreAPIApi->putRasRunStatusById: $@\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()
body =  # UpdateRunStatusRequest | 
runid = runid_example # String | Run Id
clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Update the status of a test run
    api_response = api_instance.put_ras_run_status_by_id(body, runid, clientApiVersion=clientApiVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResultArchiveStoreAPIApi->putRasRunStatusById: %s\n" % e)

Parameters

Path parameters
Name Description
runid*
String
Run Id
Required
Header parameters
Name Description
ClientApiVersion
String
Body parameters
Name Description
body *

Responses

Status: 200 - Run status updated

Status: 400 - Bad request

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

Status: 500 - Internal Server Error


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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            TestRuns result = apiInstance.getRunsGroup(groupId, clientApiVersion);
            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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            TestRuns result = apiInstance.getRunsGroup(groupId, clientApiVersion);
            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
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Get group runs
[apiInstance getRunsGroupWith:groupId
    clientApiVersion:clientApiVersion
              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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRunsGroup(groupId, opts, 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
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Get group runs
                TestRuns result = apiInstance.getRunsGroup(groupId, clientApiVersion);
                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
$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->getRunsGroup($groupId, $clientApiVersion);
    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
my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getRunsGroup(groupId => $groupId, clientApiVersion => $clientApiVersion);
    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
clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Get group runs
    api_response = api_instance.get_runs_group(groupId, clientApiVersion=clientApiVersion)
    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
Header parameters
Name Description
ClientApiVersion
String

Responses

Status: 200 - Run Info

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


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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            TestRuns result = apiInstance.postSubmitTestRuns(body, groupId, clientApiVersion);
            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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            TestRuns result = apiInstance.postSubmitTestRuns(body, groupId, clientApiVersion);
            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
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Sumbit test runs
[apiInstance postSubmitTestRunsWith:body
    groupId:groupId
    clientApiVersion:clientApiVersion
              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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postSubmitTestRuns(bodygroupId, opts, 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
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Sumbit test runs
                TestRuns result = apiInstance.postSubmitTestRuns(body, groupId, clientApiVersion);
                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
$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->postSubmitTestRuns($body, $groupId, $clientApiVersion);
    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
my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->postSubmitTestRuns(body => $body, groupId => $groupId, clientApiVersion => $clientApiVersion);
    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
clientApiVersion = clientApiVersion_example # String |  (optional)

try: 
    # Sumbit test runs
    api_response = api_instance.post_submit_test_runs(body, groupId, clientApiVersion=clientApiVersion)
    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
Header parameters
Name Description
ClientApiVersion
String
Body parameters
Name Description
body *

Responses

Status: 201 - Test Submitted

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


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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            Worklist result = apiInstance.addWebuiWorklistRunId(runId, clientApiVersion);
            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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            Worklist result = apiInstance.addWebuiWorklistRunId(runId, clientApiVersion);
            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
String *clientApiVersion = clientApiVersion_example; //  (optional)

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

// Add RAS runId to Worklist
[apiInstance addWebuiWorklistRunIdWith:runId
    clientApiVersion:clientApiVersion
              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 opts = { 
  'clientApiVersion': clientApiVersion_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addWebuiWorklistRunId(runId, opts, 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
            var clientApiVersion = clientApiVersion_example;  // String |  (optional) 

            try
            {
                // Add RAS runId to Worklist
                Worklist result = apiInstance.addWebuiWorklistRunId(runId, clientApiVersion);
                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
$clientApiVersion = clientApiVersion_example; // String | 

try {
    $result = $api_instance->addWebuiWorklistRunId($runId, $clientApiVersion);
    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
my $clientApiVersion = clientApiVersion_example; # String | 

eval { 
    my $result = $api_instance->addWebuiWorklistRunId(runId => $runId, clientApiVersion => $clientApiVersion);
    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
clientApiVersion = clientApiVersion_example # String |  (optional)

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

Parameters

Header parameters
Name Description
ClientApiVersion
String
Query parameters
Name Description
runId*
String
Run ID
Required

Responses

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

Status: 404 - Run not found


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
        String clientApiVersion = clientApiVersion_example; // String | 
        try {
            Worklist result = apiInstance.deleteWebuiWorklistRunId(runId, clientApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebUIWorklistAPIApi#deleteWebuiWorklistRunId");
            e.printStac