cyperf.TestResultsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
delete_result	DELETE /api/v2/results/{resultId}
delete_result_file	DELETE /api/v2/results/{resultId}/files/{fileId}
get_result_by_id	GET /api/v2/results/{resultId}
get_result_download_all_by_id	GET /api/v2/results/{resultId}/download-all/{downloadAllId}
get_result_download_result_config	GET /api/v2/results/{resultId}/download-result-config
get_result_file_by_id	GET /api/v2/results/{resultId}/files/{fileId}
get_result_file_content	GET /api/v2/results/{resultId}/files/{fileId}/content
get_result_files	GET /api/v2/results/{resultId}/files
get_results	GET /api/v2/results
get_results_tags	GET /api/v2/results/tags
poll_result_generate_all	GET /api/v2/results/{resultId}/operations/generate-all/{id}
poll_result_generate_results	GET /api/v2/results/{resultId}/operations/generate-results/{id}
poll_result_load	GET /api/v2/results/{resultId}/operations/load/{id}
poll_results_batch_delete	GET /api/v2/results/operations/batch-delete/{id}
start_result_generate_all	POST /api/v2/results/{resultId}/operations/generate-all
start_result_generate_results	POST /api/v2/results/{resultId}/operations/generate-results
start_result_load	POST /api/v2/results/{resultId}/operations/load
start_results_batch_delete	POST /api/v2/results/operations/batch-delete

delete_result

delete_result(result_id)

Delete a particular result.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.

    try:
        api_instance.delete_result(result_id)
    except Exception as e:
        print("Exception when calling TestResultsApi->delete_result: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	The result was successfully deleted.	-
403	The initiator of the request does not have enough privileges to perform the action.	-
404	A result with the specified ID was not found.	-
500	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_result_file

delete_result_file(result_id, file_id)

Delete a particular result file.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    file_id = 'file_id_example' # str | The ID of the file.

    try:
        api_instance.delete_result_file(result_id, file_id)
    except Exception as e:
        print("Exception when calling TestResultsApi->delete_result_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
file_id	str	The ID of the file.

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	The file was successfully deleted.	-
404	A result or file with the specified ID was not found.	-
500	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_result_by_id

ResultMetadata get_result_by_id(result_id)

Get a particular result.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.result_metadata import ResultMetadata
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.

    try:
        api_response = api_instance.get_result_by_id(result_id)
        print("The response of TestResultsApi->get_result_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->get_result_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.

Return type

ResultMetadata

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The requested result	-
404	A result with the specified ID was not found.	-
500	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_result_download_all_by_id

get_result_download_all_by_id(result_id, download_all_id)

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    download_all_id = 'download_all_id_example' # str | The ID of the download all.

    try:
        api_instance.get_result_download_all_by_id(result_id, download_all_id)
    except Exception as e:
        print("Exception when calling TestResultsApi->get_result_download_all_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
download_all_id	str	The ID of the download all.

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
404	A resource with the specified ID was not found.	-
500	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_result_download_result_config

object get_result_download_result_config(result_id)

Download the configuration associated with the result.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.

    try:
        api_response = api_instance.get_result_download_result_config(result_id)
        print("The response of TestResultsApi->get_result_download_result_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->get_result_download_result_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.

Return type

object

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The content of the zip file	-
500	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_result_file_by_id

ResultFileMetadata get_result_file_by_id(result_id, file_id)

Get a particular result file.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.result_file_metadata import ResultFileMetadata
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    file_id = 'file_id_example' # str | The ID of the file.

    try:
        api_response = api_instance.get_result_file_by_id(result_id, file_id)
        print("The response of TestResultsApi->get_result_file_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->get_result_file_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
file_id	str	The ID of the file.

Return type

ResultFileMetadata

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The requested file	-
404	A result or file with the specified ID was not found.	-
500	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_result_file_content

get_result_file_content(result_id, file_id)

Get the content of a result file.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    file_id = 'file_id_example' # str | The ID of the file.

    try:
        api_instance.get_result_file_content(result_id, file_id)
    except Exception as e:
        print("Exception when calling TestResultsApi->get_result_file_content: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
file_id	str	The ID of the file.

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The content of the result file	-
404	A result or file with the specified ID was not found.	-
500	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_result_files

GetResultFiles200Response get_result_files(result_id, take=take, skip=skip)

Get the list of files for a specific result.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.get_result_files200_response import GetResultFiles200Response
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    take = 56 # int | The number of search results to return (optional)
    skip = 56 # int | The number of search results to skip (optional)

    try:
        api_response = api_instance.get_result_files(result_id, take=take, skip=skip)
        print("The response of TestResultsApi->get_result_files:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->get_result_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
take	int	The number of search results to return	[optional]
skip	int	The number of search results to skip	[optional]

Return type

GetResultFiles200Response

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The list of files	-
404	A result with the specified ID was not found.	-
500	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_results

GetResults200Response get_results(take=take, skip=skip, search_col=search_col, search_val=search_val, filter_mode=filter_mode, sort=sort)

Get all the available results.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.get_results200_response import GetResults200Response
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    take = 56 # int | The number of search results to return (optional)
    skip = 56 # int | The number of search results to skip (optional)
    search_col = 'search_col_example' # str | A list of comma-separated columns used to search for the supplied values (optional)
    search_val = 'search_val_example' # str | The keywords used to filter the items (optional)
    filter_mode = 'filter_mode_example' # str | The operator applied to the supplied values (optional)
    sort = 'sort_example' # str | A list of comma-separated field:direction pairs used to sort the items where direction must be asc or dsc (optional)

    try:
        api_response = api_instance.get_results(take=take, skip=skip, search_col=search_col, search_val=search_val, filter_mode=filter_mode, sort=sort)
        print("The response of TestResultsApi->get_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->get_results: %s\n" % e)

Parameters

Name	Type	Description	Notes
take	int	The number of search results to return	[optional]
skip	int	The number of search results to skip	[optional]
search_col	str	A list of comma-separated columns used to search for the supplied values	[optional]
search_val	str	The keywords used to filter the items	[optional]
filter_mode	str	The operator applied to the supplied values	[optional]
sort	str	A list of comma-separated field:direction pairs used to sort the items where direction must be asc or dsc	[optional]

Return type

GetResults200Response

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The list of results	-
500	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_results_tags

GetResultsTags200Response get_results_tags(take=take, skip=skip)

Get all the currently available agent groups.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.get_results_tags200_response import GetResultsTags200Response
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    take = 56 # int | The number of search results to return (optional)
    skip = 56 # int | The number of search results to skip (optional)

    try:
        api_response = api_instance.get_results_tags(take=take, skip=skip)
        print("The response of TestResultsApi->get_results_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->get_results_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
take	int	The number of search results to return	[optional]
skip	int	The number of search results to skip	[optional]

Return type

GetResultsTags200Response

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The list of agent groups	-
500	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

poll_result_generate_all

AsyncContext poll_result_generate_all(result_id, id)

Get the state of an ongoing operation.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    id = 56 # int | The ID of the async operation.

    try:
        api_response = api_instance.poll_result_generate_all(result_id, id)
        print("The response of TestResultsApi->poll_result_generate_all:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->poll_result_generate_all: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
id	int	The ID of the async operation.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details about the ongoing operation	-
400	Bad request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

poll_result_generate_results

AsyncContext poll_result_generate_results(result_id, id)

Get the state of an ongoing operation.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    id = 56 # int | The ID of the async operation.

    try:
        api_response = api_instance.poll_result_generate_results(result_id, id)
        print("The response of TestResultsApi->poll_result_generate_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->poll_result_generate_results: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
id	int	The ID of the async operation.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details about the ongoing operation	-
400	Bad request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

poll_result_load

AsyncContext poll_result_load(result_id, id)

Get the state of an ongoing operation.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    id = 56 # int | The ID of the async operation.

    try:
        api_response = api_instance.poll_result_load(result_id, id)
        print("The response of TestResultsApi->poll_result_load:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->poll_result_load: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
id	int	The ID of the async operation.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details about the ongoing operation	-
400	Bad request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

poll_results_batch_delete

AsyncContext poll_results_batch_delete(id)

Get the state of an ongoing operation.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    id = 56 # int | The ID of the async operation.

    try:
        api_response = api_instance.poll_results_batch_delete(id)
        print("The response of TestResultsApi->poll_results_batch_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->poll_results_batch_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	The ID of the async operation.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details about the ongoing operation	-
400	Bad request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

start_result_generate_all

AsyncContext start_result_generate_all(result_id, generate_all_operation=generate_all_operation)

Generate all result types.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.generate_all_operation import GenerateAllOperation
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.
    generate_all_operation = cyperf.GenerateAllOperation() # GenerateAllOperation |  (optional)

    try:
        api_response = api_instance.start_result_generate_all(result_id, generate_all_operation=generate_all_operation)
        print("The response of TestResultsApi->start_result_generate_all:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->start_result_generate_all: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.
generate_all_operation	GenerateAllOperation		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

start_result_generate_results

AsyncContext start_result_generate_results(result_id)

Export all result files zipped.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.

    try:
        api_response = api_instance.start_result_generate_results(result_id)
        print("The response of TestResultsApi->start_result_generate_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->start_result_generate_results: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

start_result_load

AsyncContext start_result_load(result_id)

Loads a completed result into a new session.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    result_id = 'result_id_example' # str | The ID of the result.

    try:
        api_response = api_instance.start_result_load(result_id)
        print("The response of TestResultsApi->start_result_load:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->start_result_load: %s\n" % e)

Parameters

Name	Type	Description	Notes
result_id	str	The ID of the result.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

start_results_batch_delete

AsyncContext start_results_batch_delete(start_agents_batch_delete_request_inner=start_agents_batch_delete_request_inner)

Remove multiple results.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.start_agents_batch_delete_request_inner import StartAgentsBatchDeleteRequestInner
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.TestResultsApi(api_client)
    start_agents_batch_delete_request_inner = [cyperf.StartAgentsBatchDeleteRequestInner()] # List[StartAgentsBatchDeleteRequestInner] |  (optional)

    try:
        api_response = api_instance.start_results_batch_delete(start_agents_batch_delete_request_inner=start_agents_batch_delete_request_inner)
        print("The response of TestResultsApi->start_results_batch_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestResultsApi->start_results_batch_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
start_agents_batch_delete_request_inner	List[StartAgentsBatchDeleteRequestInner]		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

TestResultsApi.md

Latest commit

History

TestResultsApi.md

File metadata and controls

cyperf.TestResultsApi

delete_result

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_result_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_result_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_result_download_all_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_result_download_result_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_result_file_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_result_file_content

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_result_files

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_results

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_results_tags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

poll_result_generate_all

Example

Parameters