testgear_api_client.TestResultsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
api_v2_test_results_id_aggregated_get	GET /api/v2/testResults/{id}/aggregated	Get test result by ID aggregated with previous results
api_v2_test_results_id_attachments_attachment_id_put	PUT /api/v2/testResults/{id}/attachments/{attachmentId}	Attach file to the test result
api_v2_test_results_id_attachments_info_get	GET /api/v2/testResults/{id}/attachments/info	Get test result attachments meta-information
api_v2_test_results_id_get	GET /api/v2/testResults/{id}	Get test result by ID
api_v2_test_results_id_put	PUT /api/v2/testResults/{id}	Edit test result by ID
api_v2_test_results_search_post	POST /api/v2/testResults/search	Search for test results
api_v2_test_results_statistics_filter_post	POST /api/v2/testResults/statistics/filter	Search for test results and extract statistics
create_attachment	POST /api/v2/testResults/{id}/attachments	Upload and link attachment to TestResult
delete_attachment	DELETE /api/v2/testResults/{id}/attachments/{attachmentId}	Remove attachment and unlink from TestResult
download_attachment	GET /api/v2/testResults/{id}/attachments/{attachmentId}	Get attachment of TestResult
get_attachment	GET /api/v2/testResults/{id}/attachments/{attachmentId}/info	Get Metadata of TestResult's attachment
get_attachments	GET /api/v2/testResults/{id}/attachments	Get all attachments of TestResult

api_v2_test_results_id_aggregated_get

TestResultModel api_v2_test_results_id_aggregated_get(id)

Get test result by ID aggregated with previous results

Example

Api Key Authentication (Bearer or PrivateToken):

import time
import testgear_api_client
from testgear_api_client.api import test_results_api
from testgear_api_client.model.test_result_model import TestResultModel
from testgear_api_client.model.problem_details import ProblemDetails
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 = testgear_api_client.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.

# Configure API key authorization: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = 'Bearer'

# Enter a context with an instance of the API client
with testgear_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.TestResultsApi(api_client)
    id = "id_example" # str | Test result unique ID

    # example passing only required values which don't have defaults set
    try:
        # Get test result by ID aggregated with previous results
        api_response = api_instance.api_v2_test_results_id_aggregated_get(id)
        pprint(api_response)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->api_v2_test_results_id_aggregated_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Test result unique ID

Return type

TestResultModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Read permission for the test result is required	-

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

api_v2_test_results_id_attachments_attachment_id_put

api_v2_test_results_id_attachments_attachment_id_put(id, attachment_id)

Attach file to the test result

Example

Api Key Authentication (Bearer or PrivateToken):

import time
import testgear_api_client
from testgear_api_client.api import test_results_api
from testgear_api_client.model.problem_details import ProblemDetails
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 = testgear_api_client.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.

# Configure API key authorization: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = 'Bearer'

# Enter a context with an instance of the API client
with testgear_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.TestResultsApi(api_client)
    id = "id_example" # str | Test result unique ID
    attachment_id = "attachmentId_example" # str | Attachment unique ID

    # example passing only required values which don't have defaults set
    try:
        # Attach file to the test result
        api_instance.api_v2_test_results_id_attachments_attachment_id_put(id, attachment_id)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->api_v2_test_results_id_attachments_attachment_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Test result unique ID
attachment_id	str	Attachment unique ID

Return type

void (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Only edits from assigned user are allowed	-

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

api_v2_test_results_id_attachments_info_get

[AttachmentModel] api_v2_test_results_id_attachments_info_get(id)

Get test result attachments meta-information

Example

Api Key Authentication (Bearer or PrivateToken):

import time
import testgear_api_client
from testgear_api_client.api import test_results_api
from testgear_api_client.model.problem_details import ProblemDetails
from testgear_api_client.model.attachment_model import AttachmentModel
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 = testgear_api_client.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.

# Configure API key authorization: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = 'Bearer'

# Enter a context with an instance of the API client
with testgear_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.TestResultsApi(api_client)
    id = "id_example" # str | Test result unique ID

    # example passing only required values which don't have defaults set
    try:
        # Get test result attachments meta-information
        api_response = api_instance.api_v2_test_results_id_attachments_info_get(id)
        pprint(api_response)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->api_v2_test_results_id_attachments_info_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Test result unique ID

Return type

[AttachmentModel]

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Read permission for the test result is required	-

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

api_v2_test_results_id_get

TestResultModel api_v2_test_results_id_get(id)

Get test result by ID

Example

Api Key Authentication (Bearer or PrivateToken):

import time
import testgear_api_client
from testgear_api_client.api import test_results_api
from testgear_api_client.model.test_result_model import TestResultModel
from testgear_api_client.model.problem_details import ProblemDetails
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 = testgear_api_client.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.

# Configure API key authorization: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = 'Bearer'

# Enter a context with an instance of the API client
with testgear_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.TestResultsApi(api_client)
    id = "id_example" # str | Test result unique ID

    # example passing only required values which don't have defaults set
    try:
        # Get test result by ID
        api_response = api_instance.api_v2_test_results_id_get(id)
        pprint(api_response)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->api_v2_test_results_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Test result unique ID

Return type

TestResultModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Read permission for the test result is required	-

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

api_v2_test_results_id_put

api_v2_test_results_id_put(id)

Edit test result by ID

Example

Api Key Authentication (Bearer or PrivateToken):

import time
import testgear_api_client
from testgear_api_client.api import test_results_api
from testgear_api_client.model.problem_details import ProblemDetails
from testgear_api_client.model.api_v2_test_results_id_put_request import ApiV2TestResultsIdPutRequest
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 = testgear_api_client.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.

# Configure API key authorization: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = 'Bearer'

# Enter a context with an instance of the API client
with testgear_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.TestResultsApi(api_client)
    id = "id_example" # str | Test result unique ID
    api_v2_test_results_id_put_request = ApiV2TestResultsIdPutRequest(None) # ApiV2TestResultsIdPutRequest |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Edit test result by ID
        api_instance.api_v2_test_results_id_put(id)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->api_v2_test_results_id_put: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Edit test result by ID
        api_instance.api_v2_test_results_id_put(id, api_v2_test_results_id_put_request=api_v2_test_results_id_put_request)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->api_v2_test_results_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Test result unique ID
api_v2_test_results_id_put_request	ApiV2TestResultsIdPutRequest		[optional]

Return type

void (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Only edits from assigned user are allowed	-

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

api_v2_test_results_search_post

[TestResultShortGetModel] api_v2_test_results_search_post()

Search for test results

Example

Api Key Authentication (Bearer or PrivateToken):

import time
import testgear_api_client
from testgear_api_client.api import test_results_api
from testgear_api_client.model.test_result_short_get_model import TestResultShortGetModel
from testgear_api_client.model.problem_details import ProblemDetails
from testgear_api_client.model.api_v2_test_results_search_post_request import ApiV2TestResultsSearchPostRequest
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 = testgear_api_client.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.

# Configure API key authorization: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = 'Bearer'

# Enter a context with an instance of the API client
with testgear_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.TestResultsApi(api_client)
    skip = 1 # int | Amount of items to be skipped (offset) (optional)
    take = 1 # int | Amount of items to be taken (limit) (optional)
    order_by = "OrderBy_example" # str | SQL-like  ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC) (optional)
    search_field = "SearchField_example" # str | Property name for searching (optional)
    search_value = "SearchValue_example" # str | Value for searching (optional)
    api_v2_test_results_search_post_request = ApiV2TestResultsSearchPostRequest(None) # ApiV2TestResultsSearchPostRequest |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Search for test results
        api_response = api_instance.api_v2_test_results_search_post(skip=skip, take=take, order_by=order_by, search_field=search_field, search_value=search_value, api_v2_test_results_search_post_request=api_v2_test_results_search_post_request)
        pprint(api_response)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->api_v2_test_results_search_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
skip	int	Amount of items to be skipped (offset)	[optional]
take	int	Amount of items to be taken (limit)	[optional]
order_by	str	SQL-like ORDER BY statement (column1 ASC	DESC , column2 ASC
search_field	str	Property name for searching	[optional]
search_value	str	Value for searching	[optional]
api_v2_test_results_search_post_request	ApiV2TestResultsSearchPostRequest		[optional]

Return type

[TestResultShortGetModel]

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success	* Pagination-Skip - Skipped amount of items * Pagination-Take - Taken items * Pagination-Pages - Expected number of pages * Pagination-Total-Items - Total count of items
403	Read permission for all requested test runs is required	-

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

api_v2_test_results_statistics_filter_post

TestResultsStatisticsGetModel api_v2_test_results_statistics_filter_post()

Search for test results and extract statistics

Example

Api Key Authentication (Bearer or PrivateToken):

import time
import testgear_api_client
from testgear_api_client.api import test_results_api
from testgear_api_client.model.problem_details import ProblemDetails
from testgear_api_client.model.api_v2_test_results_search_post_request import ApiV2TestResultsSearchPostRequest
from testgear_api_client.model.test_results_statistics_get_model import TestResultsStatisticsGetModel
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 = testgear_api_client.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.

# Configure API key authorization: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = 'Bearer'

# Enter a context with an instance of the API client
with testgear_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.TestResultsApi(api_client)
    api_v2_test_results_search_post_request = ApiV2TestResultsSearchPostRequest(None) # ApiV2TestResultsSearchPostRequest |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Search for test results and extract statistics
        api_response = api_instance.api_v2_test_results_statistics_filter_post(api_v2_test_results_search_post_request=api_v2_test_results_search_post_request)
        pprint(api_response)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->api_v2_test_results_statistics_filter_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
api_v2_test_results_search_post_request	ApiV2TestResultsSearchPostRequest		[optional]

Return type

TestResultsStatisticsGetModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Read permission for all requested test runs is required	-

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

create_attachment

str create_attachment(id)

Upload and link attachment to TestResult

Use case
User sets testResultId
User attaches a file
System creates attachment and links it to the test result
System returns attachment identifier

Example

Api Key Authentication (Bearer or PrivateToken):

import time
import testgear_api_client
from testgear_api_client.api import test_results_api
from testgear_api_client.model.problem_details import ProblemDetails
from testgear_api_client.model.validation_problem_details import ValidationProblemDetails
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 = testgear_api_client.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.

# Configure API key authorization: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = 'Bearer'

# Enter a context with an instance of the API client
with testgear_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.TestResultsApi(api_client)
    id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test result internal identifier (guid format)
    file = open('/path/to/file', 'rb') # file_type | Select file (optional)

    # example passing only required values which don't have defaults set
    try:
        # Upload and link attachment to TestResult
        api_response = api_instance.create_attachment(id)
        pprint(api_response)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->create_attachment: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Upload and link attachment to TestResult
        api_response = api_instance.create_attachment(id, file=file)
        pprint(api_response)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->create_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Test result internal identifier (guid format)
file	file_type	Select file	[optional]

Return type

str

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-
403	Update permission for test result required	-
404		-
413	Multipart body length limit exceeded (default constraint is one gigabyte)	-

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

delete_attachment

delete_attachment(id, attachment_id)

Remove attachment and unlink from TestResult

Use case
User sets testResultId and attachmentId
User attaches a file
User runs method execution
System deletes attachment and unlinks it from the test result
System returns attachment identifier

Example

Api Key Authentication (Bearer or PrivateToken):

import time
import testgear_api_client
from testgear_api_client.api import test_results_api
from testgear_api_client.model.problem_details import ProblemDetails
from testgear_api_client.model.validation_problem_details import ValidationProblemDetails
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 = testgear_api_client.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.

# Configure API key authorization: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = 'Bearer'

# Enter a context with an instance of the API client
with testgear_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.TestResultsApi(api_client)
    id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test result internal identifier (guid format)
    attachment_id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Attachment internal identifier (guid format)

    # example passing only required values which don't have defaults set
    try:
        # Remove attachment and unlink from TestResult
        api_instance.delete_attachment(id, attachment_id)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->delete_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Test result internal identifier (guid format)
attachment_id	str	Attachment internal identifier (guid format)

Return type

void (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Successful operation	-
400	Bad Request	-
401	Unauthorized	-
403	Update permission for test result required	-

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

download_attachment

download_attachment(attachment_id, id)

Get attachment of TestResult

Use case
User sets attachmentId and testResultId
[Optional] User sets resize configuration
User runs method execution
System search attachments by the attachmentId and the testResultId
[Optional] If resize configuration is set, System resizes the attachment according to the resize configuration
[Optional] Otherwise, System does not resize the attachment
System returns attachment as a file

Example

Api Key Authentication (Bearer or PrivateToken):

import time
import testgear_api_client
from testgear_api_client.api import test_results_api
from testgear_api_client.model.image_resize_type import ImageResizeType
from testgear_api_client.model.problem_details import ProblemDetails
from testgear_api_client.model.validation_problem_details import ValidationProblemDetails
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 = testgear_api_client.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.

# Configure API key authorization: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = 'Bearer'

# Enter a context with an instance of the API client
with testgear_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.TestResultsApi(api_client)
    attachment_id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Attachment internal identifier (guid format)
    id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test result internal identifier (guid format)
    width = 1 # int | Width of the result image (optional)
    height = 1 # int | Height of the result image (optional)
    resize_type = None # ImageResizeType | Type of resizing to apply to the result image (optional)
    background_color = "#62ECB0" # str | Color of the background if the `resizeType` is `AddBackgroundStripes` (optional)
    preview = True # bool | If image must be converted to a preview (lower quality, no animation) (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get attachment of TestResult
        api_instance.download_attachment(attachment_id, id)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->download_attachment: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get attachment of TestResult
        api_instance.download_attachment(attachment_id, id, width=width, height=height, resize_type=resize_type, background_color=background_color, preview=preview)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->download_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
attachment_id	str	Attachment internal identifier (guid format)
id	str	Test result internal identifier (guid format)
width	int	Width of the result image	[optional]
height	int	Height of the result image	[optional]
resize_type	ImageResizeType	Type of resizing to apply to the result image	[optional]
background_color	str	Color of the background if the `resizeType` is `AddBackgroundStripes`	[optional]
preview	bool	If image must be converted to a preview (lower quality, no animation)	[optional]

Return type

void (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
401	Unauthorized	-
403	Read permission for test result required	-
404	<br>File not found <br>Attachment not found	-

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

get_attachment

AttachmentModel get_attachment(id, attachment_id)

Get Metadata of TestResult's attachment

Use case
User sets attachmentId and testResultId
User runs method execution
System search attachment by the attachmentId and the testResultId
System returns attachment data

Example

Api Key Authentication (Bearer or PrivateToken):

import time
import testgear_api_client
from testgear_api_client.api import test_results_api
from testgear_api_client.model.problem_details import ProblemDetails
from testgear_api_client.model.attachment_model import AttachmentModel
from testgear_api_client.model.validation_problem_details import ValidationProblemDetails
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 = testgear_api_client.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.

# Configure API key authorization: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = 'Bearer'

# Enter a context with an instance of the API client
with testgear_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.TestResultsApi(api_client)
    id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test result internal identifier (guid format)
    attachment_id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Attachment internal identifier (guid format)

    # example passing only required values which don't have defaults set
    try:
        # Get Metadata of TestResult's attachment
        api_response = api_instance.get_attachment(id, attachment_id)
        pprint(api_response)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->get_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Test result internal identifier (guid format)
attachment_id	str	Attachment internal identifier (guid format)

Return type

AttachmentModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-
403	Read permission for test result required	-
404	File not found	-

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

get_attachments

[AttachmentModel] get_attachments(id)

Get all attachments of TestResult

Use case
User sets testResultId
User runs method execution
System search all attachments of the test result
System returns attachments enumeration

Example

Api Key Authentication (Bearer or PrivateToken):

import time
import testgear_api_client
from testgear_api_client.api import test_results_api
from testgear_api_client.model.problem_details import ProblemDetails
from testgear_api_client.model.attachment_model import AttachmentModel
from testgear_api_client.model.validation_problem_details import ValidationProblemDetails
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 = testgear_api_client.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.

# Configure API key authorization: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer or PrivateToken'] = 'Bearer'

# Enter a context with an instance of the API client
with testgear_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.TestResultsApi(api_client)
    id = "3fa85f64-5717-4562-b3fc-2c963f66afa6" # str | Test result internal identifier (guid format)

    # example passing only required values which don't have defaults set
    try:
        # Get all attachments of TestResult
        api_response = api_instance.get_attachments(id)
        pprint(api_response)
    except testgear_api_client.ApiException as e:
        print("Exception when calling TestResultsApi->get_attachments: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Test result internal identifier (guid format)

Return type

[AttachmentModel]

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
401	Unauthorized	-
403	Read permission for test result required	-
404	TestResult not found	-

[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

testgear_api_client.TestResultsApi

api_v2_test_results_id_aggregated_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v2_test_results_id_attachments_attachment_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v2_test_results_id_attachments_info_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v2_test_results_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v2_test_results_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v2_test_results_search_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v2_test_results_statistics_filter_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_attachment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_attachment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_attachment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_attachment

Example

Parameters