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.
curl -X GET\
-H "Accept: application/json"\
"//ras/runs?sort=&result=&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) {
ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
String sort = sort_example; // String | Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.
Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.
You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.
String result = result_example; // String | Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
String bundle = bundle_example; // String | The name of the OSGi bundle that the desired test run(s) were loaded with.
String requestor = requestor_example; // String | Name of the test requestor / submitter
Date from = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that started at a time after this date and time.
The only scenario in which from can be omitted is when a runname has been supplied
Date to = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.
String testname = testname_example; // String | The full test name (package + short test name)
Integer page = 56; // Integer | Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.
Integer size = 56; // Integer | The number of test results returned within each page.
If omitted, the default value is 100.
String runId = runId_example; // String | The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.
String runname = runname_example; // String | The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.
try {
RunResults result = apiInstance.getRasSearchRuns(sort, result, bundle, requestor, from, to, testname, page, size, runId, runname);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ResultArchiveStoreAPIApi#getRasSearchRuns");
e.printStackTrace();
}
}
}
import io.swagger.client.api.ResultArchiveStoreAPIApi;
public class ResultArchiveStoreAPIApiExample {
public static void main(String[] args) {
ResultArchiveStoreAPIApi apiInstance = new ResultArchiveStoreAPIApi();
String sort = sort_example; // String | Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.
Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.
You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.
String result = result_example; // String | Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
String bundle = bundle_example; // String | The name of the OSGi bundle that the desired test run(s) were loaded with.
String requestor = requestor_example; // String | Name of the test requestor / submitter
Date from = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that started at a time after this date and time.
The only scenario in which from can be omitted is when a runname has been supplied
Date to = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.
String testname = testname_example; // String | The full test name (package + short test name)
Integer page = 56; // Integer | Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.
Integer size = 56; // Integer | The number of test results returned within each page.
If omitted, the default value is 100.
String runId = runId_example; // String | The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.
String runname = runname_example; // String | The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.
try {
RunResults result = apiInstance.getRasSearchRuns(sort, result, 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();
}
}
}
String *sort = sort_example; // Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.
Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.
You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.
String *result = result_example; // Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
(optional)
String *bundle = bundle_example; // The name of the OSGi bundle that the desired test run(s) were loaded with.
(optional)
String *requestor = requestor_example; // Name of the test requestor / submitter (optional)
Date *from = 2013-10-20T19:20:30+01:00; // Retrieve runs that started at a time after this date and time.
The only scenario in which from can be omitted is when a runname has been supplied
(optional)
Date *to = 2013-10-20T19:20:30+01:00; // Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.
(optional)
String *testname = testname_example; // The full test name (package + short test name) (optional)
Integer *page = 56; // Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.
(optional)
Integer *size = 56; // The number of test results returned within each page.
If omitted, the default value is 100.
(optional)
String *runId = runId_example; // The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.
(optional)
String *runname = runname_example; // The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.
(optional)
ResultArchiveStoreAPIApi *apiInstance = [[ResultArchiveStoreAPIApi alloc] init];
// Get Runs from Query
[apiInstance getRasSearchRunsWith:sort
result:result
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 api = new GalasaEcosystemApi.ResultArchiveStoreAPIApi()
var sort = sort_example; // {{String}} Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.
Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.
You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.
var opts = {
'result': result_example, // {{String}} Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
'bundle': bundle_example, // {{String}} The name of the OSGi bundle that the desired test run(s) were loaded with.
'requestor': requestor_example, // {{String}} Name of the test requestor / submitter
'from': 2013-10-20T19:20:30+01:00, // {{Date}} Retrieve runs that started at a time after this date and time.
The only scenario in which from can be omitted is when a runname has been supplied
'to': 2013-10-20T19:20:30+01:00, // {{Date}} Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.
'testname': testname_example, // {{String}} The full test name (package + short test name)
'page': 56, // {{Integer}} Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.
'size': 56, // {{Integer}} The number of test results returned within each page.
If omitted, the default value is 100.
'runId': runId_example, // {{String}} The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.
'runname': runname_example // {{String}} The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getRasSearchRuns(sort, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getRasSearchRunsExample
{
public void main()
{
var apiInstance = new ResultArchiveStoreAPIApi();
var sort = sort_example; // String | Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.
Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.
You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.
var result = result_example; // String | Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
(optional)
var bundle = bundle_example; // String | The name of the OSGi bundle that the desired test run(s) were loaded with.
(optional)
var requestor = requestor_example; // String | Name of the test requestor / submitter (optional)
var from = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that started at a time after this date and time.
The only scenario in which from can be omitted is when a runname has been supplied
(optional)
var to = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.
(optional)
var testname = testname_example; // String | The full test name (package + short test name) (optional)
var page = 56; // Integer | Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.
(optional)
var size = 56; // Integer | The number of test results returned within each page.
If omitted, the default value is 100.
(optional)
var runId = runId_example; // String | The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.
(optional)
var runname = runname_example; // String | The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.
(optional)
try
{
// Get Runs from Query
RunResults result = apiInstance.getRasSearchRuns(sort, result, bundle, requestor, from, to, testname, page, size, runId, runname);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling ResultArchiveStoreAPIApi.getRasSearchRuns: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiResultArchiveStoreAPIApi();
$sort = sort_example; // String | Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.
Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.
You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.
$result = result_example; // String | Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
$bundle = bundle_example; // String | The name of the OSGi bundle that the desired test run(s) were loaded with.
$requestor = requestor_example; // String | Name of the test requestor / submitter
$from = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that started at a time after this date and time.
The only scenario in which from can be omitted is when a runname has been supplied
$to = 2013-10-20T19:20:30+01:00; // Date | Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.
$testname = testname_example; // String | The full test name (package + short test name)
$page = 56; // Integer | Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.
$size = 56; // Integer | The number of test results returned within each page.
If omitted, the default value is 100.
$runId = runId_example; // String | The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.
$runname = runname_example; // String | The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.
try {
$result = $api_instance->getRasSearchRuns($sort, $result, $bundle, $requestor, $from, $to, $testname, $page, $size, $runId, $runname);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ResultArchiveStoreAPIApi->getRasSearchRuns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResultArchiveStoreAPIApi;
my $api_instance = WWW::SwaggerClient::ResultArchiveStoreAPIApi->new();
my $sort = sort_example; # String | Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.
Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.
You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.
my $result = result_example; # String | Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
my $bundle = bundle_example; # String | The name of the OSGi bundle that the desired test run(s) were loaded with.
my $requestor = requestor_example; # String | Name of the test requestor / submitter
my $from = 2013-10-20T19:20:30+01:00; # Date | Retrieve runs that started at a time after this date and time.
The only scenario in which from can be omitted is when a runname has been supplied
my $to = 2013-10-20T19:20:30+01:00; # Date | Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.
my $testname = testname_example; # String | The full test name (package + short test name)
my $page = 56; # Integer | Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.
my $size = 56; # Integer | The number of test results returned within each page.
If omitted, the default value is 100.
my $runId = runId_example; # String | The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.
my $runname = runname_example; # String | The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.
eval {
my $result = $api_instance->getRasSearchRuns(sort => $sort, result => $result, bundle => $bundle, requestor => $requestor, from => $from, to => $to, testname => $testname, page => $page, size => $size, runId => $runId, runname => $runname);
print Dumper($result);
};
if ($@) {
warn "Exception when calling ResultArchiveStoreAPIApi->getRasSearchRuns: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.ResultArchiveStoreAPIApi()
sort = sort_example # String | Sorts the returned runs based on the sort field.
Supports sorting fields 'to','result' and 'testclass'.
Use '{FIELD-NAME}:asc' to sort in ascending order.
Use '{FIELD-NAME}:desc' to sort in descending order.
You can use multiple instances of this query parameter, or specify
multiple sort orders using one query parameter, and a comma-separated
list of sort orders.
result = result_example # String | Result Status for the run. Commonly queried values: 'EnvFail','Passed','Failed'
(optional)
bundle = bundle_example # String | The name of the OSGi bundle that the desired test run(s) were loaded with.
(optional)
requestor = requestor_example # String | Name of the test requestor / submitter (optional)
from = 2013-10-20T19:20:30+01:00 # Date | Retrieve runs that started at a time after this date and time.
The only scenario in which from can be omitted is when a runname has been supplied
(optional)
to = 2013-10-20T19:20:30+01:00 # Date | Retrieve runs that ended at a date and time prior to this date and time value.
If you specify this parameter, only test runs which have completed will be returned.
Tests currently in-flight will not be visible.
(optional)
testname = testname_example # String | The full test name (package + short test name) (optional)
page = 56 # Integer | Causes a specific page in the available results to be returned.
The first page is page 1.
If omitted, then page 1 is returned.
(optional)
size = 56 # Integer | The number of test results returned within each page.
If omitted, the default value is 100.
(optional)
runId = runId_example # String | The ID for a specific test run as seen by the RAS.
This number is unique across the system, so using this field you can expect
one or zero test runs in the first page.
(optional)
runname = runname_example # String | The name of the test run for which details will be returned.
It will normally be unique, but this is not guaranteed, so you may see
multiple results for the same runname under some rare circumstances.
(optional)
try:
# Get Runs from Query
api_response = api_instance.get_ras_search_runs(sort, result=result, 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)