swagger_client.RequirementApi

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

Method	HTTP request	Description
add_comment	POST /api/v3/projects/{projectId}/requirements/{idOrKey}/comments	Adds a Comment to a Requirement
create_requirement	POST /api/v3/projects/{projectId}/requirements	Creates a Requirement
delete	DELETE /api/v3/projects/{projectId}/requirements/{requirementId}	Deletes a Requirement
delete_comment	DELETE /api/v3/projects/{projectId}/requirements/{idOrKey}/comments/{commentId}	Deletes a Comment of a Requirement
get_comment	GET /api/v3/projects/{projectId}/requirements/{idOrKey}/comments/{commentId}	Gets a Comment of a Requirement
get_comments	GET /api/v3/projects/{projectId}/requirements/{idOrKey}/comments	Gets all Comments of a Requirement
get_public_traceability_matrix_report	GET /api/v3/projects/{projectId}/requirements/trace-matrix-report	Gets Requirement Traceability Matrix Report
get_requirement	GET /api/v3/projects/{projectId}/requirements/{requirementId}	Gets a Requirement
get_requirements	GET /api/v3/projects/{projectId}/requirements	Gets multiple Requirements
update_comment	PUT /api/v3/projects/{projectId}/requirements/{idOrKey}/comments/{commentId}	Updates a Comment of a Requirement
update_requirement	PUT /api/v3/projects/{projectId}/requirements/{requirementId}	Updates a Requirement

add_comment

CommentResource add_comment(project_id, id_or_key, body)

Adds a Comment to a Requirement

To add a comment to a Requirement 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.RequirementApi()
project_id = 789 # int | ID of the project
id_or_key = 'id_or_key_example' # str | PID or ID of the Requirement.
body = swagger_client.CommentResource() # CommentResource | The comment's properties and its content

try: 
    # Adds a Comment to a Requirement
    api_response = api_instance.add_comment(project_id, id_or_key, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequirementApi->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 Requirement.
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]

create_requirement

RequirementResource create_requirement(project_id, body, parent_id=parent_id)

Creates a Requirement

To create a new Requirement 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.RequirementApi()
project_id = 789 # int | ID of the project
body = swagger_client.RequirementResource() # RequirementResource | <p><em>name *:</em> Requirement name</p><p><em>properties:</em> An array of field-value pairs</p>
parent_id = 789 # int | ID of the parent Module under which the Requirement will be located (optional)

try: 
    # Creates a Requirement
    api_response = api_instance.create_requirement(project_id, body, parent_id=parent_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequirementApi->create_requirement: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
body	RequirementResource	<p><em>name *:</em> Requirement name</p><p><em>properties:</em> An array of field-value pairs</p>
parent_id	int	ID of the parent Module under which the Requirement will be located	[optional]

Return type

RequirementResource

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

object delete(project_id, requirement_id)

Deletes a Requirement

To delete a Requirement 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.RequirementApi()
project_id = 789 # int | ID of the project
requirement_id = 789 # int | ID of the Requirement which needs to be deleted.

try: 
    # Deletes a Requirement
    api_response = api_instance.delete(project_id, requirement_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequirementApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
requirement_id	int	ID of the Requirement which needs to be deleted.

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_comment

object delete_comment(project_id, id_or_key, comment_id)

Deletes a Comment of a Requirement

To delete a comment of a Requirement 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.RequirementApi()
project_id = 789 # int | ID of the project
id_or_key = 'id_or_key_example' # str | PID or ID of the Requirement whose comment you want to delete
comment_id = 789 # int | The comment's ID

try: 
    # Deletes a Comment of a Requirement
    api_response = api_instance.delete_comment(project_id, id_or_key, comment_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequirementApi->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 Requirement whose comment you want to delete
comment_id	int	The comment's ID

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 Requirement

To retrieve a comment of a Requirement 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.RequirementApi()
project_id = 789 # int | ID of the project
id_or_key = 'id_or_key_example' # str | PID or ID of the Requirement whose comment you want to delete
comment_id = 789 # int | The comment's ID

try: 
    # Gets a Comment of a Requirement
    api_response = api_instance.get_comment(project_id, id_or_key, comment_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequirementApi->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 Requirement whose comment you want to delete
comment_id	int	The comment's ID

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)

Gets all Comments of a Requirement

To retrieve all comments of a Requirement qTest Manager version: 7.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.RequirementApi()
project_id = 789 # int | ID of the project
id_or_key = 'id_or_key_example' # str | PID or ID of the Requirement whose comments you want to retrieve

try: 
    # Gets all Comments of a Requirement
    api_response = api_instance.get_comments(project_id, id_or_key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequirementApi->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 Requirement whose comments you want to retrieve

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_public_traceability_matrix_report

list[TraceabilityRequirement] get_public_traceability_matrix_report(project_id, page=page, size=size, field_ids=field_ids)

Gets Requirement Traceability Matrix Report

To retrieve a report of Requirements with their covering Test Cases

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.RequirementApi()
project_id = 789 # int | ID of the project
page = 1 # int | By default the first page is returned but you can specify any page number to retrieve requirements. (optional) (default to 1)
size = 20 # int | The result is paginated. By default, the number of requirements in each page is 20.  You can specify your custom number in this parameter and the maximum number is 999. (optional) (default to 20)
field_ids = 'field_ids_example' # str | ID(s) of requirement fields (system or custom fields) which you would like to retrieve.  They are separated by commas. (optional)

try: 
    # Gets Requirement Traceability Matrix Report
    api_response = api_instance.get_public_traceability_matrix_report(project_id, page=page, size=size, field_ids=field_ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequirementApi->get_public_traceability_matrix_report: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
page	int	By default the first page is returned but you can specify any page number to retrieve requirements.	[optional] [default to 1]
size	int	The result is paginated. By default, the number of requirements in each page is 20. You can specify your custom number in this parameter and the maximum number is 999.	[optional] [default to 20]
field_ids	str	ID(s) of requirement fields (system or custom fields) which you would like to retrieve. They are separated by commas.	[optional]

Return type

list[TraceabilityRequirement]

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_requirement

RequirementResource get_requirement(project_id, requirement_id)

Gets a Requirement

To retrieve a Requirement 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.RequirementApi()
project_id = 789 # int | ID of the project
requirement_id = 789 # int | ID of the Requirement which you want to retrieve.

try: 
    # Gets a Requirement
    api_response = api_instance.get_requirement(project_id, requirement_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequirementApi->get_requirement: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
requirement_id	int	ID of the Requirement which you want to retrieve.

Return type

RequirementResource

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_requirements

list[RequirementResource] get_requirements(project_id, parent_id=parent_id, page=page, size=size)

Gets multiple Requirements

To retrieve all Requirements or Requirements under a specific 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.RequirementApi()
project_id = 789 # int | ID of the project
parent_id = 789 # int | Specify the parent Module's ID to retrieve all of its Requirements which are located directly under the parent Module (optional)
page = 1 # int | By default the first page is returned but you can specify any page number to retrieve requirements. (optional) (default to 1)
size = 56 # 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. (optional)

try: 
    # Gets multiple Requirements
    api_response = api_instance.get_requirements(project_id, parent_id=parent_id, page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequirementApi->get_requirements: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
parent_id	int	Specify the parent Module's ID to retrieve all of its Requirements which are located directly under the parent Module	[optional]
page	int	By default the first page is returned but you can specify any page number to retrieve requirements.	[optional] [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.	[optional]

Return type

list[RequirementResource]

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 Requirement

To modify a comment of a Requirement 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.RequirementApi()
project_id = 789 # int | ID of the project
id_or_key = 'id_or_key_example' # str | PID or ID of the Requirement whose comment you want to update
comment_id = 789 # int | The comment's ID
body = swagger_client.CommentResource() # CommentResource | The comment's updated content

try: 
    # Updates a Comment of a Requirement
    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 RequirementApi->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 Requirement whose comment you want to update
comment_id	int	The comment's ID
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_requirement

RequirementResource update_requirement(project_id, requirement_id, body, parent_id=parent_id)

Updates a Requirement

To update properties of an Requirement or to move it to other parent 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.RequirementApi()
project_id = 789 # int | ID of the project
requirement_id = 789 # int | ID of the Requirement which needs to be updated.
body = swagger_client.RequirementResource() # RequirementResource | <strong>name: *</strong> Requirement name.  <strong>properties:</strong> An array of field-value pairs
parent_id = 789 # int | ID of the parent Module to which the Requirement will be moved to (optional)

try: 
    # Updates a Requirement
    api_response = api_instance.update_requirement(project_id, requirement_id, body, parent_id=parent_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequirementApi->update_requirement: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	int	ID of the project
requirement_id	int	ID of the Requirement which needs to be updated.
body	RequirementResource	<strong>name: *</strong> Requirement name. <strong>properties:</strong> An array of field-value pairs
parent_id	int	ID of the parent Module to which the Requirement will be moved to	[optional]

Return type

RequirementResource

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

RequirementApi.md

Latest commit

History

RequirementApi.md

File metadata and controls

swagger_client.RequirementApi

add_comment

Example

Parameters

Return type

Authorization

HTTP request headers

create_requirement

Example

Parameters

Return type

Authorization

HTTP request headers

delete

Example

Parameters

Return type

Authorization

HTTP request headers

delete_comment

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_public_traceability_matrix_report

Example

Parameters

Return type

Authorization

HTTP request headers

get_requirement

Example

Parameters

Return type

Authorization

HTTP request headers

get_requirements

Example

Parameters

Return type

Authorization

HTTP request headers

update_comment

Example

Parameters

Return type

Authorization

HTTP request headers

update_requirement

Example

Parameters

Return type

Authorization

HTTP request headers