TestrunsApi.md

pyjama.TestrunsApi

All URIs are relative to http://<jama_endpoint>/rest/latest

Method	HTTP request	Description
add_test_run_attachment	POST /testruns/{id}/attachments	Add an existing attachment to the item with the specified ID
add_test_run_link	POST /testruns/{id}/links	Create a new link for the item with the specified ID
add_test_run_tag	POST /testruns/{id}/tags	Add an existing tag to the item with the specified ID
delete_test_run	DELETE /testruns/{id}	Delete the test run with the specified ID
delete_test_run_link	DELETE /testruns/{id}/links/{linkId}	Delete the link with the specified ID
get_test_run	GET /testruns/{id}	Get the test run with the specified ID
get_test_run_activities	GET /testruns/{id}/activities	Get all activities for the test run with the specified ID
get_test_run_attachments	GET /testruns/{id}/attachments	Get all attachments for the item with the specified ID
get_test_run_comments	GET /testruns/{id}/comments	Get all comments for the item with the specified ID
get_test_run_downstream_related	GET /testruns/{id}/downstreamrelated	Get all downstream related items for the test run with the specified ID
get_test_run_downstream_relationships	GET /testruns/{id}/downstreamrelationships	Get all downstream relationships for the test run with the specified ID
get_test_run_link	GET /testruns/{id}/links/{linkId}	Get the link with the specified ID
get_test_run_links	GET /testruns/{id}/links	Get all links for the item with the specified ID
get_test_run_lock	GET /testruns/{id}/lock	Get the locked state, last locked date, and last locked by user for the item with the specified ID
get_test_run_tag	GET /testruns/{id}/tags/{tagId}	Get the tag with the specified ID
get_test_run_tags	GET /testruns/{id}/tags	Get all tags for the item with the specified ID
get_test_run_upstream_related	GET /testruns/{id}/upstreamrelated	Get all upstream related items for the test run with the specified ID
get_test_run_upstream_relationships	GET /testruns/{id}/upstreamrelationships	Get all upstream relationships for the test run with the specified ID
get_test_run_version	GET /testruns/{id}/versions/{versionNum}/versioneditem	Get the snapshot of the test run at the specified version
get_test_run_versioned	GET /testruns/{id}/versions/{versionNum}	Get the numbered version for the item with the specified ID
get_test_run_versions	GET /testruns/{id}/versions	Get all versions for the item with the specified ID
get_test_runs	GET /testruns	Search for test runs associated with test cases, test plans, an test cycles
make_test_run_current	POST /testruns/{id}/updatedtestcase	Delete the current test run and then create a new test run based on the latest test case version.
patch_test_run	PATCH /testruns/{id}	Update the execution results for the test run with the specified ID
remove_attachment_from_test_run	DELETE /testruns/{id}/attachments/{attachmentId}	Remove an existing attachment from the item
remove_test_runs_tag_from_item	DELETE /testruns/{id}/tags/{tagId}	Remove an existing tag from the item with the specified ID
update_test_run	PUT /testruns/{id}	Update the execution results for the test run with the specified ID
update_test_run_link	PUT /testruns/{id}/links/{linkId}	Update the link with the specified ID
update_test_run_lock	PUT /testruns/{id}/lock	Update the locked state of the item with the specified ID

add_test_run_attachment

CreatedResponse add_test_run_attachment(id, body)

Add an existing attachment to the item with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.request_item_attachment import RequestItemAttachment
from pyjama.model.created_response import CreatedResponse
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    body = RequestItemAttachment(
        attachment=1,
    ) # RequestItemAttachment | 

    # example passing only required values which don't have defaults set
    try:
        # Add an existing attachment to the item with the specified ID
        api_response = api_instance.add_test_run_attachment(id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->add_test_run_attachment: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	RequestItemAttachment

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

add_test_run_link

CreatedResponse add_test_run_link(id, body)

Create a new link for the item with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.created_response import CreatedResponse
from pyjama.model.request_link import RequestLink
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    body = RequestLink(
        url="url_example",
        description="description_example",
    ) # RequestLink | 

    # example passing only required values which don't have defaults set
    try:
        # Create a new link for the item with the specified ID
        api_response = api_instance.add_test_run_link(id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->add_test_run_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	RequestLink

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

add_test_run_tag

CreatedResponse add_test_run_tag(id, body)

Add an existing tag to the item with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.created_response import CreatedResponse
from pyjama.model.request_item_tag import RequestItemTag
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    body = RequestItemTag(
        tag=1,
    ) # RequestItemTag | 

    # example passing only required values which don't have defaults set
    try:
        # Add an existing tag to the item with the specified ID
        api_response = api_instance.add_test_run_tag(id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->add_test_run_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	RequestItemTag

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

delete_test_run

AbstractRestResponse delete_test_run(id)

Delete the test run with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.abstract_rest_response import AbstractRestResponse
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 

    # example passing only required values which don't have defaults set
    try:
        # Delete the test run with the specified ID
        api_response = api_instance.delete_test_run(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->delete_test_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

delete_test_run_link

AbstractRestResponse delete_test_run_link(link_id, id)

Delete the link with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.abstract_rest_response import AbstractRestResponse
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    link_id = 1 # int | 
    id = 1 # int | 

    # example passing only required values which don't have defaults set
    try:
        # Delete the link with the specified ID
        api_response = api_instance.delete_test_run_link(link_id, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->delete_test_run_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
link_id	int
id	int

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run

TestRunDataWrapper get_test_run(id)

Get the test run with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.test_run_data_wrapper import TestRunDataWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get the test run with the specified ID
        api_response = api_instance.get_test_run(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get the test run with the specified ID
        api_response = api_instance.get_test_run(id, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

TestRunDataWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_activities

ActivityDataListWrapper get_test_run_activities(id)

Get all activities for the test run with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.activity_data_list_wrapper import ActivityDataListWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all activities for the test run with the specified ID
        api_response = api_instance.get_test_run_activities(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_activities: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all activities for the test run with the specified ID
        api_response = api_instance.get_test_run_activities(id, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_activities: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
start_at	int		[optional]
max_results	int	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

ActivityDataListWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_attachments

AttachmentDataListWrapper get_test_run_attachments(id)

Get all attachments for the item with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.attachment_data_list_wrapper import AttachmentDataListWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all attachments for the item with the specified ID
        api_response = api_instance.get_test_run_attachments(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_attachments: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all attachments for the item with the specified ID
        api_response = api_instance.get_test_run_attachments(id, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_attachments: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
start_at	int		[optional]
max_results	int	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

AttachmentDataListWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_comments

CommentDataListWrapper get_test_run_comments(id)

Get all comments for the item with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.comment_data_list_wrapper import CommentDataListWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    root_comments_only = False # bool |  (optional) if omitted the server will use the default value of False
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all comments for the item with the specified ID
        api_response = api_instance.get_test_run_comments(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_comments: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all comments for the item with the specified ID
        api_response = api_instance.get_test_run_comments(id, start_at=start_at, max_results=max_results, root_comments_only=root_comments_only, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_comments: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
start_at	int		[optional]
max_results	int	If not set, this defaults to 20. This cannot be larger than 50	[optional]
root_comments_only	bool		[optional] if omitted the server will use the default value of False
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

CommentDataListWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_downstream_related

AbstractItemDataListWrapper get_test_run_downstream_related(id)

Get all downstream related items for the test run with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.abstract_item_data_list_wrapper import AbstractItemDataListWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all downstream related items for the test run with the specified ID
        api_response = api_instance.get_test_run_downstream_related(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_downstream_related: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all downstream related items for the test run with the specified ID
        api_response = api_instance.get_test_run_downstream_related(id, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_downstream_related: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
start_at	int		[optional]
max_results	int	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

AbstractItemDataListWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_downstream_relationships

RelationshipDataListWrapper get_test_run_downstream_relationships(id)

Get all downstream relationships for the test run with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.relationship_data_list_wrapper import RelationshipDataListWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all downstream relationships for the test run with the specified ID
        api_response = api_instance.get_test_run_downstream_relationships(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_downstream_relationships: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all downstream relationships for the test run with the specified ID
        api_response = api_instance.get_test_run_downstream_relationships(id, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_downstream_relationships: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
start_at	int		[optional]
max_results	int	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

RelationshipDataListWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_link

LinkDataWrapper get_test_run_link(link_id, id)

Get the link with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.link_data_wrapper import LinkDataWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    link_id = 1 # int | 
    id = 1 # int | 
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get the link with the specified ID
        api_response = api_instance.get_test_run_link(link_id, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_link: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get the link with the specified ID
        api_response = api_instance.get_test_run_link(link_id, id, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
link_id	int
id	int
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

LinkDataWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_links

LinkDataListWrapper get_test_run_links(id)

Get all links for the item with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.link_data_list_wrapper import LinkDataListWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all links for the item with the specified ID
        api_response = api_instance.get_test_run_links(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_links: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all links for the item with the specified ID
        api_response = api_instance.get_test_run_links(id, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_links: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
start_at	int		[optional]
max_results	int	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

LinkDataListWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_lock

LockDataWrapper get_test_run_lock(id)

Get the locked state, last locked date, and last locked by user for the item with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.lock_data_wrapper import LockDataWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get the locked state, last locked date, and last locked by user for the item with the specified ID
        api_response = api_instance.get_test_run_lock(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_lock: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get the locked state, last locked date, and last locked by user for the item with the specified ID
        api_response = api_instance.get_test_run_lock(id, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_lock: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

LockDataWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_tag

TagDataWrapper get_test_run_tag(tag_id, id)

Get the tag with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.tag_data_wrapper import TagDataWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    tag_id = 1 # int | 
    id = 1 # int | 
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get the tag with the specified ID
        api_response = api_instance.get_test_run_tag(tag_id, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_tag: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get the tag with the specified ID
        api_response = api_instance.get_test_run_tag(tag_id, id, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_id	int
id	int
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

TagDataWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_tags

TagDataListWrapper get_test_run_tags(id)

Get all tags for the item with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.tag_data_list_wrapper import TagDataListWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all tags for the item with the specified ID
        api_response = api_instance.get_test_run_tags(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_tags: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all tags for the item with the specified ID
        api_response = api_instance.get_test_run_tags(id, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
start_at	int		[optional]
max_results	int	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

TagDataListWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_upstream_related

AbstractItemDataListWrapper get_test_run_upstream_related(id)

Get all upstream related items for the test run with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.abstract_item_data_list_wrapper import AbstractItemDataListWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all upstream related items for the test run with the specified ID
        api_response = api_instance.get_test_run_upstream_related(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_upstream_related: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all upstream related items for the test run with the specified ID
        api_response = api_instance.get_test_run_upstream_related(id, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_upstream_related: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
start_at	int		[optional]
max_results	int	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

AbstractItemDataListWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_upstream_relationships

RelationshipDataListWrapper get_test_run_upstream_relationships(id)

Get all upstream relationships for the test run with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.relationship_data_list_wrapper import RelationshipDataListWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all upstream relationships for the test run with the specified ID
        api_response = api_instance.get_test_run_upstream_relationships(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_upstream_relationships: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all upstream relationships for the test run with the specified ID
        api_response = api_instance.get_test_run_upstream_relationships(id, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_upstream_relationships: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
start_at	int		[optional]
max_results	int	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

RelationshipDataListWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_version

VersionedTestRunDataWrapper get_test_run_version(version_num, id)

Get the snapshot of the test run at the specified version

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.versioned_test_run_data_wrapper import VersionedTestRunDataWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    version_num = 1 # int | 
    id = 1 # int | 
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get the  snapshot of the test run at the specified version
        api_response = api_instance.get_test_run_version(version_num, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_version: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get the  snapshot of the test run at the specified version
        api_response = api_instance.get_test_run_version(version_num, id, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_version: %s\n" % e)

Parameters

Name	Type	Description	Notes
version_num	int
id	int
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

VersionedTestRunDataWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_versioned

VersionDataWrapper get_test_run_versioned(version_num, id)

Get the numbered version for the item with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.version_data_wrapper import VersionDataWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    version_num = 1 # int | 
    id = 1 # int | 
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get the numbered version for the item with the specified ID
        api_response = api_instance.get_test_run_versioned(version_num, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_versioned: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get the numbered version for the item with the specified ID
        api_response = api_instance.get_test_run_versioned(version_num, id, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_versioned: %s\n" % e)

Parameters

Name	Type	Description	Notes
version_num	int
id	int
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

VersionDataWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_run_versions

VersionDataListWrapper get_test_run_versions(id)

Get all versions for the item with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.version_data_list_wrapper import VersionDataListWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all versions for the item with the specified ID
        api_response = api_instance.get_test_run_versions(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_versions: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all versions for the item with the specified ID
        api_response = api_instance.get_test_run_versions(id, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_run_versions: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
start_at	int		[optional]
max_results	int	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

VersionDataListWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

get_test_runs

TestRunDataListWrapper get_test_runs()

Search for test runs associated with test cases, test plans, an test cycles

Must include at least one query parameter from testCycle, testCase, or testPlan

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.test_run_data_list_wrapper import TestRunDataListWrapper
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    test_cycle = [
        1,
    ] # [int] | Filter by test runs in test cycle id (optional)
    test_case = [
        1,
    ] # [int] | Filter by test runs from test case id (optional)
    test_plan = [
        1,
    ] # [int] | Filter by test runs in test plan id (optional)
    sort_by = [
        "sortBy_example",
    ] # [str] | Sort orders can be added with the name of the field by which to sort, followed by .asc or .desc (e.g. 'name.asc' or 'testCycle.desc'). If not set, this defaults to documentKey.asc. (optional)
    start_at = 1 # int |  (optional)
    max_results = 1 # int | If not set, this defaults to 20. This cannot be larger than 50 (optional)
    include = [
        "include_example",
    ] # [str] | Links to include as full objects in the linked map (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Search for test runs associated with test cases, test plans, an test cycles
        api_response = api_instance.get_test_runs(test_cycle=test_cycle, test_case=test_case, test_plan=test_plan, sort_by=sort_by, start_at=start_at, max_results=max_results, include=include)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->get_test_runs: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_cycle	[int]	Filter by test runs in test cycle id	[optional]
test_case	[int]	Filter by test runs from test case id	[optional]
test_plan	[int]	Filter by test runs in test plan id	[optional]
sort_by	[str]	Sort orders can be added with the name of the field by which to sort, followed by .asc or .desc (e.g. 'name.asc' or 'testCycle.desc'). If not set, this defaults to documentKey.asc.	[optional]
start_at	int		[optional]
max_results	int	If not set, this defaults to 20. This cannot be larger than 50	[optional]
include	[str]	Links to include as full objects in the linked map	[optional]

Return type

TestRunDataListWrapper

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

make_test_run_current

CreatedResponse make_test_run_current(id)

Delete the current test run and then create a new test run based on the latest test case version.

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.created_response import CreatedResponse
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 

    # example passing only required values which don't have defaults set
    try:
        # Delete the current test run and then create a new test run based on the latest test case version.
        api_response = api_instance.make_test_run_current(id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->make_test_run_current: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

patch_test_run

AbstractRestResponse patch_test_run(id, body)

Update the execution results for the test run with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.request_patch_operation import RequestPatchOperation
from pyjama.model.abstract_rest_response import AbstractRestResponse
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    body = [
        RequestPatchOperation(
            op="remove",
            path="path_example",
            value={},
        ),
    ] # [RequestPatchOperation] | 

    # example passing only required values which don't have defaults set
    try:
        # Update the execution results for the test run with the specified ID
        api_response = api_instance.patch_test_run(id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->patch_test_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	[RequestPatchOperation]

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

remove_attachment_from_test_run

AbstractRestResponse remove_attachment_from_test_run(attachment_id, id)

Remove an existing attachment from the item

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.abstract_rest_response import AbstractRestResponse
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    attachment_id = 1 # int | 
    id = 1 # int | 

    # example passing only required values which don't have defaults set
    try:
        # Remove an existing attachment from the item
        api_response = api_instance.remove_attachment_from_test_run(attachment_id, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->remove_attachment_from_test_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
attachment_id	int
id	int

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

remove_test_runs_tag_from_item

AbstractRestResponse remove_test_runs_tag_from_item(tag_id, id)

Remove an existing tag from the item with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.abstract_rest_response import AbstractRestResponse
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    tag_id = 1 # int | 
    id = 1 # int | 

    # example passing only required values which don't have defaults set
    try:
        # Remove an existing tag from the item with the specified ID
        api_response = api_instance.remove_test_runs_tag_from_item(tag_id, id)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->remove_test_runs_tag_from_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_id	int
id	int

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

update_test_run

AbstractRestResponse update_test_run(id, body)

Update the execution results for the test run with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.request_test_run import RequestTestRun
from pyjama.model.abstract_rest_response import AbstractRestResponse
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    body = RequestTestRun(
        fields={
            "key": {},
        },
    ) # RequestTestRun | 

    # example passing only required values which don't have defaults set
    try:
        # Update the execution results for the test run with the specified ID
        api_response = api_instance.update_test_run(id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->update_test_run: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	RequestTestRun

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

update_test_run_link

AbstractRestResponse update_test_run_link(link_id, id, body)

Update the link with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.request_link import RequestLink
from pyjama.model.abstract_rest_response import AbstractRestResponse
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    link_id = 1 # int | 
    id = 1 # int | 
    body = RequestLink(
        url="url_example",
        description="description_example",
    ) # RequestLink | 

    # example passing only required values which don't have defaults set
    try:
        # Update the link with the specified ID
        api_response = api_instance.update_test_run_link(link_id, id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->update_test_run_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
link_id	int
id	int
body	RequestLink

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

update_test_run_lock

AbstractRestResponse update_test_run_lock(id, body)

Update the locked state of the item with the specified ID

Example

• Basic Authentication (basic):
• OAuth Authentication (oauth2):

import time
import pyjama
from pyjama.api import testruns_api
from pyjama.model.request_lock import RequestLock
from pyjama.model.abstract_rest_response import AbstractRestResponse
from pprint import pprint
# Defining the host is optional and defaults to http://<jama_endpoint>/rest/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)

# 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 HTTP basic authorization: basic
configuration = pyjama.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure OAuth2 access token for authorization: oauth2
configuration = pyjama.Configuration(
    host = "http://<jama_endpoint>/rest/latest"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pyjama.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testruns_api.TestrunsApi(api_client)
    id = 1 # int | 
    body = RequestLock(
        locked=True,
    ) # RequestLock | 

    # example passing only required values which don't have defaults set
    try:
        # Update the locked state of the item with the specified ID
        api_response = api_instance.update_test_run_lock(id, body)
        pprint(api_response)
    except pyjama.ApiException as e:
        print("Exception when calling TestrunsApi->update_test_run_lock: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
body	RequestLock

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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