qaseio.RunsApi

All URIs are relative to https://api.qase.io/v1

Method	HTTP request	Description
complete_run	POST /run/{code}/{id}/complete	Complete a specific run.
create_run	POST /run/{code}	Create a new run.
delete_run	DELETE /run/{code}/{id}	Delete run.
get_run	GET /run/{code}/{id}	Get a specific run.
get_runs	GET /run/{code}	Get all runs.
update_run_publicity	PATCH /run/{code}/{id}/public	Update publicity of a specific run.

complete_run

BaseResponse complete_run(code, id)

Complete a specific run.

This method allows to complete a specific run.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.base_response import BaseResponse
from qaseio.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qase.io/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = qaseio.Configuration(
    host = "https://api.qase.io/v1"
)

# 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: TokenAuth
configuration.api_key['TokenAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with qaseio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qaseio.RunsApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    id = 56 # int | Identifier.

    try:
        # Complete a specific run.
        api_response = api_instance.complete_run(code, id)
        print("The response of RunsApi->complete_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RunsApi->complete_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
id	int	Identifier.

Return type

BaseResponse

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A result.	-
400	Bad Request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not Found.	-
422	Unprocessable Entity.	-
429	Too Many Requests.	-

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

create_run

IdResponse create_run(code, run_create)

Create a new run.

This method allows to create a run in selected project.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.id_response import IdResponse
from qaseio.models.run_create import RunCreate
from qaseio.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qase.io/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = qaseio.Configuration(
    host = "https://api.qase.io/v1"
)

# 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: TokenAuth
configuration.api_key['TokenAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with qaseio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qaseio.RunsApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    run_create = qaseio.RunCreate() # RunCreate | 

    try:
        # Create a new run.
        api_response = api_instance.create_run(code, run_create)
        print("The response of RunsApi->create_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RunsApi->create_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
run_create	RunCreate

Return type

IdResponse

Authorization

TokenAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A result.	-
400	Bad Request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not Found.	-
422	Unprocessable Entity.	-
429	Too Many Requests.	-

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

delete_run

IdResponse delete_run(code, id)

Delete run.

This method completely deletes a run from repository.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.id_response import IdResponse
from qaseio.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qase.io/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = qaseio.Configuration(
    host = "https://api.qase.io/v1"
)

# 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: TokenAuth
configuration.api_key['TokenAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with qaseio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qaseio.RunsApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    id = 56 # int | Identifier.

    try:
        # Delete run.
        api_response = api_instance.delete_run(code, id)
        print("The response of RunsApi->delete_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RunsApi->delete_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
id	int	Identifier.

Return type

IdResponse

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A Result.	-
400	Bad Request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not Found.	-
429	Too Many Requests.	-

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

get_run

RunResponse get_run(code, id, include=include)

Get a specific run.

This method allows to retrieve a specific run.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.run_response import RunResponse
from qaseio.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qase.io/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = qaseio.Configuration(
    host = "https://api.qase.io/v1"
)

# 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: TokenAuth
configuration.api_key['TokenAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with qaseio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qaseio.RunsApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    id = 56 # int | Identifier.
    include = 'include_example' # str | Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects  (optional)

    try:
        # Get a specific run.
        api_response = api_instance.get_run(code, id, include=include)
        print("The response of RunsApi->get_run:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RunsApi->get_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
id	int	Identifier.
include	str	Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects	[optional]

Return type

RunResponse

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A run.	-
400	Bad Request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not Found.	-
429	Too Many Requests.	-

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

get_runs

RunListResponse get_runs(code, search=search, status=status, milestone=milestone, environment=environment, from_start_time=from_start_time, to_start_time=to_start_time, limit=limit, offset=offset, include=include)

Get all runs.

This method allows to retrieve all runs stored in selected project.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.run_list_response import RunListResponse
from qaseio.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qase.io/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = qaseio.Configuration(
    host = "https://api.qase.io/v1"
)

# 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: TokenAuth
configuration.api_key['TokenAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with qaseio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qaseio.RunsApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    search = 'search_example' # str |  (optional)
    status = 'status_example' # str | A list of status values separated by comma. Possible values: active, complete, abort.  (optional)
    milestone = 56 # int |  (optional)
    environment = 56 # int |  (optional)
    from_start_time = 56 # int |  (optional)
    to_start_time = 56 # int |  (optional)
    limit = 10 # int | A number of entities in result set. (optional) (default to 10)
    offset = 0 # int | How many entities should be skipped. (optional) (default to 0)
    include = 'include_example' # str | Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects  (optional)

    try:
        # Get all runs.
        api_response = api_instance.get_runs(code, search=search, status=status, milestone=milestone, environment=environment, from_start_time=from_start_time, to_start_time=to_start_time, limit=limit, offset=offset, include=include)
        print("The response of RunsApi->get_runs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RunsApi->get_runs: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Code of project, where to search entities.
search	str		[optional]
status	str	A list of status values separated by comma. Possible values: active, complete, abort.	[optional]
milestone	int		[optional]
environment	int		[optional]
from_start_time	int		[optional]
to_start_time	int		[optional]
limit	int	A number of entities in result set.	[optional] [default to 10]
offset	int	How many entities should be skipped.	[optional] [default to 0]
include	str	Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects	[optional]

Return type

RunListResponse

Authorization

TokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of all runs.	-
400	Bad Request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not Found.	-
429	Too Many Requests.	-

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

update_run_publicity

RunPublicResponse update_run_publicity(code, id, run_public)

Update publicity of a specific run.

This method allows to update a publicity of specific run.

Example

Api Key Authentication (TokenAuth):

import time
import os
import qaseio
from qaseio.models.run_public import RunPublic
from qaseio.models.run_public_response import RunPublicResponse
from qaseio.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qase.io/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = qaseio.Configuration(
    host = "https://api.qase.io/v1"
)

# 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: TokenAuth
configuration.api_key['TokenAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with qaseio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qaseio.RunsApi(api_client)
    code = 'code_example' # str | Code of project, where to search entities.
    id = 56 # int | Identifier.
    run_public = qaseio.RunPublic() # RunPublic | 

    try:
        # Update publicity of a specific run.
        api_response = api_instance.update_run_publicity(code, id, run_public)
        print("The response of RunsApi->update_run_publicity:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RunsApi->update_run_publicity: %s\n" % e)

Parameters

Name	Type	Description
code	str	Code of project, where to search entities.
id	int	Identifier.
run_public	RunPublic

Return type

RunPublicResponse

Authorization

TokenAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A result.	-
400	Bad Request.	-
401	Unauthorized.	-
403	Forbidden.	-
404	Not Found.	-
429	Too Many Requests.	-

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

Files

RunsApi.md

Latest commit

History

RunsApi.md

File metadata and controls

qaseio.RunsApi

complete_run

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_run

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_run

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_run

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_runs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_run_publicity

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details