swagger_client

SwaggerClient - the Ruby gem for the qTest Manager API Version 8.6 - 9.1

qTest Manager API Version 8.6 - 9.1

This SDK 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.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build swagger_client.gemspec

Then either install the gem locally:

gem install ./swagger_client-1.0.0.gem

(for development, run gem install --dev ./swagger_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'swagger_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'swagger_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'swagger_client'

# Setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AttachmentApi.new

project_id = 789 # Integer | ID of the project

blob_handle_id = 789 # Integer | ID of the Attachment

object_type = "object_type_example" # String | Valid values include releases, builds, requirements, test-cases, test-logs, test-steps or defects  <strong>qTest Manager version:</strong> 4+

object_id = 789 # Integer | ID of the object (Release, Build, Requirement, Test Case, Test Log, Test Step or Defect)


begin
  #Deletes an Attachment from an Object
  result = api_instance.delete(project_id, blob_handle_id, object_type, object_id)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling AttachmentApi->delete: #{e}"
end

Documentation for API Endpoints

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

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

Documentation for Models

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

Documentation for Authorization

Authorization

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