swagger_client.TestcaseApi

All URIs are relative to https://apitryout.qtestnet.com/

Method	HTTP request	Description
add_comment	POST /api/v3/projects/{projectId}/test-cases/{idOrKey}/comments	Adds a Comment to a Test Case
add_test_step	POST /api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps	Creates a Test Step
approve_test_case	PUT /api/v3/projects/{projectId}/test-cases/{testCaseId}/approve	Approves a Test Case
create_test_case	POST /api/v3/projects/{projectId}/test-cases	Creates a Test Case
delete_comment	DELETE /api/v3/projects/{projectId}/test-cases/{idOrKey}/comments/{commentId}	Deletes a Comment of a Test Case
delete_test_case	DELETE /api/v3/projects/{projectId}/test-cases/{testCaseId}	Deletes a Test Case
delete_test_step	DELETE /api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps/{stepId}	Deletes a Test Step
get_comment	GET /api/v3/projects/{projectId}/test-cases/{idOrKey}/comments/{commentId}	Gets a Comment of a Test Case
get_comments	GET /api/v3/projects/{projectId}/test-cases/{idOrKey}/comments	Gets all Comments of a Test Case
get_test_case	GET /api/v3/projects/{projectId}/test-cases/{testCaseId}	Gets a Test Case
get_test_case_0	GET /api/v3/projects/{projectId}/test-cases/{testCaseId}/versions/{versionId}	Gets a version of a Test Case
get_test_cases	GET /api/v3/projects/{projectId}/test-cases	Gets multiple Test Cases
get_test_step	GET /api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps/{stepId}	Gets a Test Step
get_test_steps	GET /api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps	Gets Test Steps of a Test Case
get_test_steps_by_version	GET /api/v3/projects/{projectId}/test-cases/{testCaseId}/versions/{versionId}/test-steps	Gets Test Steps of a Test Case version
get_versions	GET /api/v3/projects/{projectId}/test-cases/{testCaseId}/versions	Gets all versions of a Test Case
update_comment	PUT /api/v3/projects/{projectId}/test-cases/{idOrKey}/comments/{commentId}	Updates a Comment of a Test Case
update_test_case	PUT /api/v3/projects/{projectId}/test-cases/{testCaseId}	Updates a Test Case
update_test_step	PUT /api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps/{stepId}	Update a Test Step

add_comment

CommentResource add_comment(project_id, id_or_key, body)

Adds a Comment to a Test Case

To add a Comment to a Test Case qTest Manager version: 7.5+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
id_or_key = 'id_or_key_example' # str | PID or ID of the Test Case
body = swagger_client.CommentResource() # CommentResource | The comment's properties and its content

try: 
    # Adds a Comment to a Test Case
    api_response = api_instance.add_comment(project_id, id_or_key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->add_comment: %s\n" % e)

Parameters

Name	Type	Description
project_id	int	ID of the project
id_or_key	str	PID or ID of the Test Case
body	CommentResource	The comment's properties and its content

Return type

CommentResource

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

add_test_step

TestStepResource add_test_step(project_id, test_case_id, body)

Creates a Test Step

To add a Test Step to a Test Case's latest version qTest Manager version: 6+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
test_case_id = 789 # int | ID of the Test Case
body = swagger_client.TestStepResource() # TestStepResource | Given resource to add a test step.

try: 
    # Creates a Test Step
    api_response = api_instance.add_test_step(project_id, test_case_id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->add_test_step: %s\n" % e)

Parameters

Name	Type	Description
project_id	int	ID of the project
test_case_id	int	ID of the Test Case
body	TestStepResource	Given resource to add a test step.

Return type

TestStepResource

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

approve_test_case

TestCaseWithCustomFieldResource approve_test_case(project_id, test_case_id)

Approves a Test Case

To approve a Test Case qTest Manager version: 7.4+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
test_case_id = 789 # int | ID of the Test Case

try: 
    # Approves a Test Case
    api_response = api_instance.approve_test_case(project_id, test_case_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->approve_test_case: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
test_case_id	int	ID of the Test Case

Return type

TestCaseWithCustomFieldResource

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

create_test_case

TestCaseWithCustomFieldResource create_test_case(project_id, body, agent_id=agent_id)

Creates a Test Case

To create a Test Case qTest Manager version: 4+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
body = swagger_client.TestCaseWithCustomFieldResource() # TestCaseWithCustomFieldResource | Test Case properties, Test Steps, Attachments and other information to create a Test Case.  If <em>parent_id</em> is omitted, the Test Case will be created under \"Created via API\" Module
agent_id = 'agent_id_example' # str |  (optional)

try: 
    # Creates a Test Case
    api_response = api_instance.create_test_case(project_id, body, agent_id=agent_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->create_test_case: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
body	TestCaseWithCustomFieldResource	Test Case properties, Test Steps, Attachments and other information to create a Test Case. If <em>parent_id</em> is omitted, the Test Case will be created under "Created via API" Module
agent_id	str		[optional]

Return type

TestCaseWithCustomFieldResource

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

delete_comment

object delete_comment(project_id, id_or_key, comment_id)

Deletes a Comment of a Test Case

To delete a comment of a Test Case qTest Manager version: 7.5+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
id_or_key = 'id_or_key_example' # str | PID or ID of the Test Case
comment_id = 789 # int | ID of the comment.

try: 
    # Deletes a Comment of a Test Case
    api_response = api_instance.delete_comment(project_id, id_or_key, comment_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->delete_comment: %s\n" % e)

Parameters

Name	Type	Description
project_id	int	ID of the project
id_or_key	str	PID or ID of the Test Case
comment_id	int	ID of the comment.

Return type

object

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

delete_test_case

delete_test_case(project_id, test_case_id)

Deletes a Test Case

To delete Test Case qTest Manager version: 6+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
test_case_id = 789 # int | ID of the Test Case which needs to be deleted.

try: 
    # Deletes a Test Case
    api_instance.delete_test_case(project_id, test_case_id)
except ApiException as e:
    print("Exception when calling TestcaseApi->delete_test_case: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
test_case_id	int	ID of the Test Case which needs to be deleted.

Return type

void (empty response body)

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

delete_test_step

object delete_test_step(project_id, test_case_id, step_id, update_version=update_version)

Deletes a Test Step

To delete a test step of a Test Case qTest Manager version: 6+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
test_case_id = 789 # int | ID of the Test Case
step_id = 789 # int | ID of the Test Step
update_version = true # bool | If you specify updateVersion=true, the test case version will be updated when the test step deleted. (optional)

try: 
    # Deletes a Test Step
    api_response = api_instance.delete_test_step(project_id, test_case_id, step_id, update_version=update_version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->delete_test_step: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
test_case_id	int	ID of the Test Case
step_id	int	ID of the Test Step
update_version	bool	If you specify updateVersion=true, the test case version will be updated when the test step deleted.	[optional]

Return type

object

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get_comment

CommentResource get_comment(project_id, id_or_key, comment_id)

Gets a Comment of a Test Case

To retrieve a comment of a Test Case qTest Manager version: 7.5+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
id_or_key = 'id_or_key_example' # str | PID or ID of the Test Case
comment_id = 789 # int | ID of the comment.

try: 
    # Gets a Comment of a Test Case
    api_response = api_instance.get_comment(project_id, id_or_key, comment_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->get_comment: %s\n" % e)

Parameters

Name	Type	Description
project_id	int	ID of the project
id_or_key	str	PID or ID of the Test Case
comment_id	int	ID of the comment.

Return type

CommentResource

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get_comments

PagedResourceCommentResource get_comments(project_id, id_or_key, page=page, page_size=page_size)

Gets all Comments of a Test Case

To retrieve all comments of a Test Case qTest Manager version: 7.5+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
id_or_key = 'id_or_key_example' # str | PID or ID of the Test Case whose comments you want to retrieve
page = 1 # int | By default the first page is returned but you can specify any page number to retrieve objects (optional) (default to 1)
page_size = 100 # int | The result is paginated. By the default, the number of objects in each page is 100 if this is omitted. You can specify your custom number (up to 999) in this parameter (optional) (default to 100)

try: 
    # Gets all Comments of a Test Case
    api_response = api_instance.get_comments(project_id, id_or_key, page=page, page_size=page_size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->get_comments: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
id_or_key	str	PID or ID of the Test Case whose comments you want to retrieve
page	int	By default the first page is returned but you can specify any page number to retrieve objects	[optional] [default to 1]
page_size	int	The result is paginated. By the default, the number of objects in each page is 100 if this is omitted. You can specify your custom number (up to 999) in this parameter	[optional] [default to 100]

Return type

PagedResourceCommentResource

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get_test_case

TestCaseWithCustomFieldResource get_test_case(project_id, test_case_id, version_id=version_id, expand=expand)

Gets a Test Case

To retrieve a Test Case qTest Manager version: 6+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
test_case_id = 789 # int | ID of the Test Case
version_id = 789 # int | ID of the Test Case version (optional)
expand = 'expand_example' # str | By default, Test Steps are excluded from the response. Specify <em>expand=teststep</em> to include Test Steps (optional)

try: 
    # Gets a Test Case
    api_response = api_instance.get_test_case(project_id, test_case_id, version_id=version_id, expand=expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->get_test_case: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
test_case_id	int	ID of the Test Case
version_id	int	ID of the Test Case version	[optional]
expand	str	By default, Test Steps are excluded from the response. Specify <em>expand=teststep</em> to include Test Steps	[optional]

Return type

TestCaseWithCustomFieldResource

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get_test_case_0

TestCaseWithCustomFieldResource get_test_case_0(project_id, test_case_id, version_id)

Gets a version of a Test Case

To retrieve a specific version of a Test Case qTest Manager version: 4+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
test_case_id = 789 # int | ID of the Test Case
version_id = 789 # int | ID of the Test Case version

try: 
    # Gets a version of a Test Case
    api_response = api_instance.get_test_case_0(project_id, test_case_id, version_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->get_test_case_0: %s\n" % e)

Parameters

Name	Type	Description
project_id	int	ID of the project
test_case_id	int	ID of the Test Case
version_id	int	ID of the Test Case version

Return type

TestCaseWithCustomFieldResource

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get_test_cases

list[TestCaseWithCustomFieldResource] get_test_cases(project_id, page, size, parent_id=parent_id, expand_props=expand_props, expand_steps=expand_steps)

Gets multiple Test Cases

To retrieve all Test Cases or Test Cases which are located directly under a Module

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
page = 1 # int | By default the first page is returned. However, you can specify any page number to retrieve test cases. (default to 1)
size = 20 # int | The result is paginated. By the default, the number of requirements in each page is 20.  You can specify your custom number in this parameter. (default to 20)
parent_id = 789 # int | Module ID (optional)
expand_props = true # bool | By default, Test Case properties are included in the response. specify <em>expandProps=false</em> to exclude them (optional)
expand_steps = true # bool | By default, Test Steps are excluded from the response body. Input <em>expandSteps=true</em> to include Test Steps (optional)

try: 
    # Gets multiple Test Cases
    api_response = api_instance.get_test_cases(project_id, page, size, parent_id=parent_id, expand_props=expand_props, expand_steps=expand_steps)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->get_test_cases: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
page	int	By default the first page is returned. However, you can specify any page number to retrieve test cases.	[default to 1]
size	int	The result is paginated. By the default, the number of requirements in each page is 20. You can specify your custom number in this parameter.	[default to 20]
parent_id	int	Module ID	[optional]
expand_props	bool	By default, Test Case properties are included in the response. specify <em>expandProps=false</em> to exclude them	[optional]
expand_steps	bool	By default, Test Steps are excluded from the response body. Input <em>expandSteps=true</em> to include Test Steps	[optional]

Return type

list[TestCaseWithCustomFieldResource]

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get_test_step

TestStepResource get_test_step(project_id, test_case_id, step_id)

Gets a Test Step

To retrieve a Test Step of a Test Case's latest version qTest Manager version: 6+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
test_case_id = 789 # int | ID of the Test Case
step_id = 789 # int | ID of the test step.

try: 
    # Gets a Test Step
    api_response = api_instance.get_test_step(project_id, test_case_id, step_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->get_test_step: %s\n" % e)

Parameters

Name	Type	Description
project_id	int	ID of the project
test_case_id	int	ID of the Test Case
step_id	int	ID of the test step.

Return type

TestStepResource

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get_test_steps

list[TestStepResource] get_test_steps(project_id, test_case_id)

Gets Test Steps of a Test Case

To retrieve all Test Steps of a Test Case's latest version qTest Manager version: 6+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
test_case_id = 789 # int | ID of the Test Case

try: 
    # Gets Test Steps of a Test Case
    api_response = api_instance.get_test_steps(project_id, test_case_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->get_test_steps: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
test_case_id	int	ID of the Test Case

Return type

list[TestStepResource]

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get_test_steps_by_version

list[TestStepResource] get_test_steps_by_version(project_id, test_case_id, version_id, expand=expand)

Gets Test Steps of a Test Case version

To retrieve all Test Steps of a specific Test Case version

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
test_case_id = 789 # int | ID of the Test Case
version_id = 789 # int | ID of the Test Case version
expand = 'expand_example' # str | Specify <em>expand=calledteststep</em> to include Test Steps of the called Test Cases (optional)

try: 
    # Gets Test Steps of a Test Case version
    api_response = api_instance.get_test_steps_by_version(project_id, test_case_id, version_id, expand=expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->get_test_steps_by_version: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
test_case_id	int	ID of the Test Case
version_id	int	ID of the Test Case version
expand	str	Specify <em>expand=calledteststep</em> to include Test Steps of the called Test Cases	[optional]

Return type

list[TestStepResource]

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get_versions

list[TestCaseWithCustomFieldResource] get_versions(project_id, test_case_id)

Gets all versions of a Test Case

To retrieve all versions of a Test Case qTest Manager version: 7.4+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
test_case_id = 789 # int | ID of the test case

try: 
    # Gets all versions of a Test Case
    api_response = api_instance.get_versions(project_id, test_case_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->get_versions: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
test_case_id	int	ID of the test case

Return type

list[TestCaseWithCustomFieldResource]

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

update_comment

CommentResource update_comment(project_id, id_or_key, comment_id, body)

Updates a Comment of a Test Case

To modify a comment of a Test Case qTest Manager version: 7.5+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
id_or_key = 'id_or_key_example' # str | PID or ID of the Test Case
comment_id = 789 # int | ID of the comment.
body = swagger_client.CommentResource() # CommentResource | The comment's updated content

try: 
    # Updates a Comment of a Test Case
    api_response = api_instance.update_comment(project_id, id_or_key, comment_id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->update_comment: %s\n" % e)

Parameters

Name	Type	Description
project_id	int	ID of the project
id_or_key	str	PID or ID of the Test Case
comment_id	int	ID of the comment.
body	CommentResource	The comment's updated content

Return type

CommentResource

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

update_test_case

TestCaseWithCustomFieldResource update_test_case(project_id, test_case_id, body)

Updates a Test Case

To update a Test Case qTest Manager version: 6+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
test_case_id = 789 # int | ID of the Test Case which needs to be updated.
body = swagger_client.TestCaseWithCustomFieldResource() # TestCaseWithCustomFieldResource | Test Case properties, Test Steps and other information to update the Test Case

try: 
    # Updates a Test Case
    api_response = api_instance.update_test_case(project_id, test_case_id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->update_test_case: %s\n" % e)

Parameters

Name	Type	Description
project_id	int	ID of the project
test_case_id	int	ID of the Test Case which needs to be updated.
body	TestCaseWithCustomFieldResource	Test Case properties, Test Steps and other information to update the Test Case

Return type

TestCaseWithCustomFieldResource

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

update_test_step

TestStepResource update_test_step(project_id, test_case_id, step_id, body)

Update a Test Step

To update a Test Step of a Test Case's latest version qTest Manager version: 6+

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestcaseApi()
project_id = 789 # int | ID of the project
test_case_id = 789 # int | ID of the Test Case
step_id = 789 # int | ID of the Test Step
body = swagger_client.TestStepResource() # TestStepResource | Updated content of the Test Step

try: 
    # Update a Test Step
    api_response = api_instance.update_test_step(project_id, test_case_id, step_id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestcaseApi->update_test_step: %s\n" % e)

Parameters

Name	Type	Description
project_id	int	ID of the project
test_case_id	int	ID of the Test Case
step_id	int	ID of the Test Step
body	TestStepResource	Updated content of the Test Step

Return type

TestStepResource

Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

Files

TestcaseApi.md

Latest commit

History

TestcaseApi.md

File metadata and controls

swagger_client.TestcaseApi

add_comment

Example

Parameters

Return type

Authorization

HTTP request headers

add_test_step

Example

Parameters

Return type

Authorization

HTTP request headers

approve_test_case

Example

Parameters

Return type

Authorization

HTTP request headers

create_test_case

Example

Parameters

Return type

Authorization

HTTP request headers

delete_comment

Example

Parameters

Return type

Authorization

HTTP request headers

delete_test_case

Example

Parameters

Return type

Authorization

HTTP request headers

delete_test_step

Example

Parameters

Return type

Authorization

HTTP request headers

get_comment

Example

Parameters

Return type

Authorization

HTTP request headers

get_comments

Example

Parameters

Return type

Authorization

HTTP request headers

get_test_case

Example

Parameters

Return type

Authorization

HTTP request headers

get_test_case_0

Example

Parameters

Return type

Authorization

HTTP request headers

get_test_cases

Example

Parameters

Return type

Authorization

HTTP request headers

get_test_step