MaxRau/qtest-swagger-client

This repo forks the code found in the Python swagger client found here: https://api.qasymphony.com/

swagger_client

qTest Manager API Version 8.6 - 9.1

This Python package is automatically generated by the Swagger Codegen project:

• API version: 8.6 - 9.1
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
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.AttachmentApi()
project_id = 789 # int | ID of the project
blob_handle_id = 789 # int | ID of the Attachment
object_type = 'object_type_example' # str | Valid values include releases, builds, requirements, test-cases, test-logs, test-steps or defects  <strong>qTest Manager version:</strong> 4+
object_id = 789 # int | ID of the object (Release, Build, Requirement, Test Case, Test Log, Test Step or Defect)

try:
    # Deletes an Attachment from an Object
    api_response = api_instance.delete(project_id, blob_handle_id, object_type, object_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttachmentApi->delete: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AttachmentApi	delete	DELETE /api/v3/projects/{projectId}/{objectType}/{objectId}/blob-handles/{blobHandleId}	Deletes an Attachment from an Object
AttachmentApi	get_attachment	GET /api/v3/projects/{projectId}/{objectType}/{objectId}/attachments/{attachmentId}	Gets an Attachment of an Object
AttachmentApi	get_attachments_of	GET /api/v3/projects/{projectId}/{objectType}/{objectId}/attachments	Gets all Attachments of an Object
AttachmentApi	search	GET /api/v3/projects/{projectId}/attachments	Searches for Attachments
AttachmentApi	upload	POST /api/v3/projects/{projectId}/{objectType}/{objectId}/blob-handles	Uploads an Attachment to an Object
AutomationjobApi	create_schedule	POST /api/v3/automation/jobs/schedule/create	Create a Schedule
BuildApi	create	POST /api/v3/projects/{projectId}/builds	Creates a Build
BuildApi	delete	DELETE /api/v3/projects/{projectId}/builds/{buildId}	Deletes a Build
BuildApi	get	GET /api/v3/projects/{projectId}/builds/{buildId}	Gets a Build
BuildApi	get_builds	GET /api/v3/projects/{projectId}/builds	Gets multiple Builds
BuildApi	update	PUT /api/v3/projects/{projectId}/builds/{buildId}	Updates a Build
CommonApi	edit_system_field	POST /api/v3/projects/{projectId}/settings/{objectType}/system-fields/{fieldId}	Edit System Field of an Object Type by the field
CommonApi	update_custom_field	POST /api/v3/projects/{projectId}/settings/{objectType}/custom-fields/active	field.updateCustomField
DefectApi	add_comment	POST /api/v3/projects/{projectId}/defects/{idOrKey}/comments	Adds a Comment to a Defect
DefectApi	delete_comment	DELETE /api/v3/projects/{projectId}/defects/{idOrKey}/comments/{commentId}	Deletes a Comment of a Defect
DefectApi	get_comment	GET /api/v3/projects/{projectId}/defects/{idOrKey}/comments/{commentId}	Gets a Comment of a Defect
DefectApi	get_comments	GET /api/v3/projects/{projectId}/defects/{idOrKey}/comments	Gets all Comments of a Defect
DefectApi	get_defect	GET /api/v3/projects/{projectId}/defects/{defectId}	Gets a Defect
DefectApi	get_last_changed	GET /api/v3/projects/{projectId}/defects/last-change	Gets recently updated Defects
DefectApi	submit_defect	POST /api/v3/projects/{projectId}/defects	Submit a Defect
DefectApi	update_comment	PUT /api/v3/projects/{projectId}/defects/{idOrKey}/comments/{commentId}	Updates a Comment of a Defect
DefectApi	update_defect	PUT /api/v3/projects/{projectId}/defects/{defectId}	Updates a Defect
FieldApi	create	POST /api/v3/projects/{projectId}/settings/{objectType}/fields	Creates a Custom Field of an Object Type
FieldApi	get_fields	GET /api/v3/projects/{projectId}/settings/{objectType}/fields	Gets all Fields of an Object Type
LoginApi	post_access_token	POST /oauth/token	Log in
ModuleApi	create_module	POST /api/v3/projects/{projectId}/modules	Creates a Module
ModuleApi	delete_module	DELETE /api/v3/projects/{projectId}/modules/{moduleId}	Deletes a Module
ModuleApi	get_module	GET /api/v3/projects/{projectId}/modules/{moduleId}	Gets a Module
ModuleApi	get_sub_modules_of	GET /api/v3/projects/{projectId}/modules	Gets multiple Modules
ModuleApi	update_module	PUT /api/v3/projects/{projectId}/modules/{moduleId}	Updates a Module
ObjectlinkApi	find	GET /api/v3/projects/{projectId}/linked-artifacts	Gets associated objects of given objects
ObjectlinkApi	link_artifacts	POST /api/v3/projects/{projectId}/{objectType}/{objectId}/link	Creates links between objects
ObjectlinkApi	unlink_artifacts	DELETE /api/v3/projects/{projectId}/{objectType}/{objectId}/link	Removes links between objects
ProjectApi	create_project	POST /api/v3/projects	Creates a Project
ProjectApi	get_current_profile	GET /api/v3/projects/{projectId}/user-profiles/current	Gets current user Permissions in a Project
ProjectApi	get_project	GET /api/v3/projects/{projectId}	Gets a Project
ProjectApi	get_projects	GET /api/v3/projects	Gets multiple Projects
ProjectApi	get_users	GET /api/v3/projects/{projectId}/users	Gets all Users in a Project
ReleaseApi	create	POST /api/v3/projects/{projectId}/releases	Creates a Release
ReleaseApi	delete	DELETE /api/v3/projects/{projectId}/releases/{releaseId}	Delete a release
ReleaseApi	get	GET /api/v3/projects/{projectId}/releases/{releaseId}	Gets a Release
ReleaseApi	get_all	GET /api/v3/projects/{projectId}/releases	Gets multiple Releases
ReleaseApi	update	PUT /api/v3/projects/{projectId}/releases/{releaseId}	Updates a Release
RequirementApi	add_comment	POST /api/v3/projects/{projectId}/requirements/{idOrKey}/comments	Adds a Comment to a Requirement
RequirementApi	create_requirement	POST /api/v3/projects/{projectId}/requirements	Creates a Requirement
RequirementApi	delete	DELETE /api/v3/projects/{projectId}/requirements/{requirementId}	Deletes a Requirement
RequirementApi	delete_comment	DELETE /api/v3/projects/{projectId}/requirements/{idOrKey}/comments/{commentId}	Deletes a Comment of a Requirement
RequirementApi	get_comment	GET /api/v3/projects/{projectId}/requirements/{idOrKey}/comments/{commentId}	Gets a Comment of a Requirement
RequirementApi	get_comments	GET /api/v3/projects/{projectId}/requirements/{idOrKey}/comments	Gets all Comments of a Requirement
RequirementApi	get_public_traceability_matrix_report	GET /api/v3/projects/{projectId}/requirements/trace-matrix-report	Gets Requirement Traceability Matrix Report
RequirementApi	get_requirement	GET /api/v3/projects/{projectId}/requirements/{requirementId}	Gets a Requirement
RequirementApi	get_requirements	GET /api/v3/projects/{projectId}/requirements	Gets multiple Requirements
RequirementApi	update_comment	PUT /api/v3/projects/{projectId}/requirements/{idOrKey}/comments/{commentId}	Updates a Comment of a Requirement
RequirementApi	update_requirement	PUT /api/v3/projects/{projectId}/requirements/{requirementId}	Updates a Requirement
SearchApi	query_histories	POST /api/v3/projects/{projectId}/histories	Queries objects' histories
SearchApi	search	POST /api/v3/projects/{projectId}/comments	Queries Comments
SearchApi	search_0	POST /api/v3/projects/{projectId}/search	Queries objects
TestcaseApi	add_comment	POST /api/v3/projects/{projectId}/test-cases/{idOrKey}/comments	Adds a Comment to a Test Case
TestcaseApi	add_test_step	POST /api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps	Creates a Test Step
TestcaseApi	approve_test_case	PUT /api/v3/projects/{projectId}/test-cases/{testCaseId}/approve	Approves a Test Case
TestcaseApi	create_test_case	POST /api/v3/projects/{projectId}/test-cases	Creates a Test Case
TestcaseApi	delete_comment	DELETE /api/v3/projects/{projectId}/test-cases/{idOrKey}/comments/{commentId}	Deletes a Comment of a Test Case
TestcaseApi	delete_test_case	DELETE /api/v3/projects/{projectId}/test-cases/{testCaseId}	Deletes a Test Case
TestcaseApi	delete_test_step	DELETE /api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps/{stepId}	Deletes a Test Step
TestcaseApi	get_comment	GET /api/v3/projects/{projectId}/test-cases/{idOrKey}/comments/{commentId}	Gets a Comment of a Test Case
TestcaseApi	get_comments	GET /api/v3/projects/{projectId}/test-cases/{idOrKey}/comments	Gets all Comments of a Test Case
TestcaseApi	get_test_case	GET /api/v3/projects/{projectId}/test-cases/{testCaseId}	Gets a Test Case
TestcaseApi	get_test_case_0	GET /api/v3/projects/{projectId}/test-cases/{testCaseId}/versions/{versionId}	Gets a version of a Test Case
TestcaseApi	get_test_cases	GET /api/v3/projects/{projectId}/test-cases	Gets multiple Test Cases
TestcaseApi	get_test_step	GET /api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps/{stepId}	Gets a Test Step
TestcaseApi	get_test_steps	GET /api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps	Gets Test Steps of a Test Case
TestcaseApi	get_test_steps_by_version	GET /api/v3/projects/{projectId}/test-cases/{testCaseId}/versions/{versionId}/test-steps	Gets Test Steps of a Test Case version
TestcaseApi	get_versions	GET /api/v3/projects/{projectId}/test-cases/{testCaseId}/versions	Gets all versions of a Test Case
TestcaseApi	update_comment	PUT /api/v3/projects/{projectId}/test-cases/{idOrKey}/comments/{commentId}	Updates a Comment of a Test Case
TestcaseApi	update_test_case	PUT /api/v3/projects/{projectId}/test-cases/{testCaseId}	Updates a Test Case
TestcaseApi	update_test_step	PUT /api/v3/projects/{projectId}/test-cases/{testCaseId}/test-steps/{stepId}	Update a Test Step
TestcycleApi	create_cycle	POST /api/v3/projects/{projectId}/test-cycles	Create a Test Cycle
TestcycleApi	delete_cycle	DELETE /api/v3/projects/{projectId}/test-cycles/{testCycleId}	Deletes a Test Cycle
TestcycleApi	get_test_cycle	GET /api/v3/projects/{projectId}/test-cycles/{testCycleId}	Gets a Test Cycle
TestcycleApi	get_test_cycles	GET /api/v3/projects/{projectId}/test-cycles	Gets multiple Test Cycles
TestcycleApi	update_cycle	PUT /api/v3/projects/{projectId}/test-cycles/{testCycleId}	Updates a Test Cycle
TestlogApi	get_last_run_log	GET /api/v3/projects/{projectId}/test-runs/{testRunId}/test-logs/last-run	Gets the latest Test Log of a Test Run
TestlogApi	get_test_log	GET /api/v3/projects/{projectId}/test-runs/{testRunId}/test-logs/{id}	Gets a Test Log of a Test Run
TestlogApi	get_test_logs_list	GET /api/v3/projects/{projectId}/test-runs/{testRunId}/test-logs	Gets all Test Logs of a Test Run
TestlogApi	modify_automation_log	PUT /api/v3/projects/{projectId}/test-runs/{testRunId}/auto-test-logs/{id}	Modify an Automation Test Log
TestlogApi	modify_test_log	PUT /api/v3/projects/{projectId}/test-runs/{testRunId}/test-logs/{id}	Modify a Manual Test Log
TestlogApi	submit_automation_log	POST /api/v3/projects/{projectId}/test-runs/{testRunId}/auto-test-logs	Submits an Automation Test Log
TestlogApi	submit_automation_test_logs	POST /api/v3.1/projects/{projectId}/test-runs/{testRunId}/auto-test-logs	Submits multiple test results
TestlogApi	submit_automation_test_logs_0	POST /api/v3/projects/{projectId}/auto-test-logs	Submits multiple test results and specifies Test Design and Test Execution tree structures
TestlogApi	submit_test_log	POST /api/v3/projects/{projectId}/test-runs/{testRunId}/test-logs	Submits a Manual Test Log
TestlogApi	track	GET /api/v3/projects/queue-processing/{id}	Gets a Batch Test Log Submission job's state
TestrunApi	add_comment	POST /api/v3/projects/{projectId}/test-runs/{idOrKey}/comments	Adds a Comment to a Test Run
TestrunApi	create	POST /api/v3/projects/{projectId}/test-runs	Creates a Test Run
TestrunApi	delete	DELETE /api/v3/projects/{projectId}/test-runs/{testRunId}	Deletes a Test Run
TestrunApi	delete_comment	DELETE /api/v3/projects/{projectId}/test-runs/{idOrKey}/comments/{commentId}	Deletes a Comment of a Test Run
TestrunApi	get	GET /api/v3/projects/{projectId}/test-runs/{testRunId}	Gets a Test Run
TestrunApi	get_comment	GET /api/v3/projects/{projectId}/test-runs/{idOrKey}/comments/{commentId}	Gets a Comment from a Test Run
TestrunApi	get_comments	GET /api/v3/projects/{projectId}/test-runs/{idOrKey}/comments	Gets all Comments of a Test Run
TestrunApi	get_of	GET /api/v3/projects/{projectId}/test-runs	Gets multiple Test Runs
TestrunApi	get_status_valuable	GET /api/v3/projects/{projectId}/test-runs/execution-statuses	Gets Test Run statuses
TestrunApi	update	PUT /api/v3/projects/{projectId}/test-runs/{testRunId}	Updates a Test Run
TestrunApi	update_comment	PUT /api/v3/projects/{projectId}/test-runs/{idOrKey}/comments/{commentId}	Updates a Comment of a Test Run
TestsuiteApi	create_test_suite	POST /api/v3/projects/{projectId}/test-suites	Creates a Test Suite
TestsuiteApi	delete	DELETE /api/v3/projects/{projectId}/test-suites/{testSuiteId}	Deletes a Test Suite
TestsuiteApi	get	GET /api/v3/projects/{projectId}/test-suites	Gets multiple Test Suite
TestsuiteApi	get_test_suite	GET /api/v3/projects/{projectId}/test-suites/{testSuiteId}	Gets a Test Suite
TestsuiteApi	update_test_suite	PUT /api/v3/projects/{projectId}/test-suites/{testSuiteId}	Updates a Test Suite
UserApi	assign_to_project	POST /api/v3/users/{userId}/projects	Assigns a User to a Project
UserApi	assign_users_to_project	POST /api/v3/users/projects	Assigns multiple Users to a Project
UserApi	create_user	POST /api/v3/users	Invites a User
UserApi	find_by_user_name_or_email	GET /api/v3/users/search	Queries Users by Username
UserApi	find_users_by_projects_name	GET /api/v3/search/user	Queries Users by Project Name
UserApi	get_avatar	GET /api/v3/users/{userId}/avatar	Gets a User's Avatar
UserApi	get_user_by_id	GET /api/v3/users/{userId}	Gets a User
UserApi	reevaluate_token	GET /api/v3/re-evaluation	Gets current user's information
UserprofileApi	batch_assign_user_profile_in_client	POST /api/v3/user-profiles/batch-assign-users	Assigns multiple Users to a Profile
UserprofileApi	batch_assign_user_profile_in_project	POST /api/v3/user-profiles/{projectId}/batch-assign-users	Assigns multiple Users to a Profile in a Project
UserprofileApi	get_current	GET /api/v3/admin-profiles/current	Gets current User's Admin Profile
UserprofileApi	get_profiles_of_current_user	GET /api/v3/user-profiles/current	Gets current User's Profiles in different Projects
UserprofileApi	get_user_profiles	GET /api/v3/user-profiles	Gets available Profiles

Documentation For Models

• AdminProfile
• AllowedValueResource
• AppDetail
• ArtifactHistoryResource
• ArtifactSearchParams
• AssignedProject
• AssignedUsersProject
• AttachmentAuthor
• AttachmentResource
• AutomationRequest
• AutomationScheduleCreationAPI
• AutomationStepLog
• AutomationTestLog
• AutomationTestLogResource
• AutomationTestStepLog
• BuildPermission
• BuildResource
• CommentQueryParams
• CommentResource
• DefectFieldMapping
• DefectMapping
• DefectPermission
• DefectResource
• DefectTrackingSystem
• FieldResource
• HistoryChange
• HistoryQueryParams
• HistoryResource
• Link
• LinkedArtifact
• LinkedArtifactContainer
• LinkedDefectResource
• LinkedObject
• LoggedUser
• ManualTestLogResource
• Message
• ModulePermission
• ModuleResource
• OAuthResponse
• OutputStream
• PagedResource
• PagedResourceAttachmentResource
• PagedResourceCommentResource
• Profile
• ProjectAdminPermission
• ProjectResource
• ProjectSettingPermission
• ProjectUsersProfile
• PropertyResource
• QueryCommentResource
• QueueProcessingResponse
• ReleasePermission
• ReleaseWithCustomFieldResource
• ReportPermission
• RequirementPermission
• RequirementResource
• ResourceSupport
• SchedulePermission
• SearchUserResource
• SearchUserResourceExtensionResponse
• SearchUserResponse
• SessionManagerPermission
• SiteUsersProfile
• StatusResource
• TestCasePermission
• TestCaseWithCustomFieldResource
• TestCyclePermission
• TestCycleResource
• TestLogListResource
• TestLogResource
• TestRunListResource
• TestRunPermission
• TestRunWithCustomFieldResource
• TestStepLogResource
• TestStepResource
• TestSuitePermission
• TestSuiteWithCustomFieldResource
• TraceabilityRequirement
• UserProfile
• UserProfileResponse
• UserResource
• UserResourceExtension

Documentation For Authorization

Authorization

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author