Skip to content
This repository has been archived by the owner on May 7, 2021. It is now read-only.

Latest commit

 

History

History
302 lines (203 loc) · 8.39 KB

ReleaseApi.md

File metadata and controls

302 lines (203 loc) · 8.39 KB
Raw

SwaggerClient::ReleaseApi

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

Method HTTP request Description
create POST /api/v3/projects/{projectId}/releases Creates a Release
delete DELETE /api/v3/projects/{projectId}/releases/{releaseId} Delete a release
get GET /api/v3/projects/{projectId}/releases/{releaseId} Gets a Release
get_all GET /api/v3/projects/{projectId}/releases Gets multiple Releases
update PUT /api/v3/projects/{projectId}/releases/{releaseId} Updates a Release

create

ReleaseWithCustomFieldResource create(project_id, body)

Creates a Release

To create a Release qTest Manager version: 4+

Example

# 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::ReleaseApi.new

project_id = 789 # Integer | ID of the project

body = SwaggerClient::ReleaseWithCustomFieldResource.new # ReleaseWithCustomFieldResource | The Release's properties


begin
  #Creates a Release
  result = api_instance.create(project_id, body)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReleaseApi->create: #{e}"
end

Parameters

Name Type Description Notes
project_id Integer ID of the project
body ReleaseWithCustomFieldResource The Release's properties

Return type

ReleaseWithCustomFieldResource

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

delete

Object delete(project_id, release_id)

Delete a release

To delete a Release

Example

# 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::ReleaseApi.new

project_id = 789 # Integer | ID of the project

release_id = 789 # Integer | ID of the Release which needs to be deleted  <strong>qTest Manager version:</strong> 6+


begin
  #Delete a release
  result = api_instance.delete(project_id, release_id)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReleaseApi->delete: #{e}"
end

Parameters

Name Type Description Notes
project_id Integer ID of the project
release_id Integer ID of the Release which needs to be deleted <strong>qTest Manager version:</strong> 6+

Return type

Object

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

get

ReleaseWithCustomFieldResource get(project_id, release_id)

Gets a Release

To retrieve a Release qTest Manager version: 4+

Example

# 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::ReleaseApi.new

project_id = 789 # Integer | ID of the project

release_id = 789 # Integer | ID of the Release


begin
  #Gets a Release
  result = api_instance.get(project_id, release_id)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReleaseApi->get: #{e}"
end

Parameters

Name Type Description Notes
project_id Integer ID of the project
release_id Integer ID of the Release

Return type

ReleaseWithCustomFieldResource

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

get_all

Array<ReleaseWithCustomFieldResource> get_all(project_id, opts)

Gets multiple Releases

To retrieve Releases in a project qTest Manager version: 4+

Example

# 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::ReleaseApi.new

project_id = 789 # Integer | ID of the project

opts = { 
  include_closed: true # BOOLEAN | <em>includeClosed=false</em> - default value. <em>Closed</em> Releases are excluded from the response  <em>includeClosed=false</em> - Closed Release are included in the response
}

begin
  #Gets multiple Releases
  result = api_instance.get_all(project_id, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReleaseApi->get_all: #{e}"
end

Parameters

Name Type Description Notes
project_id Integer ID of the project
include_closed BOOLEAN <em>includeClosed=false</em> - default value. <em>Closed</em> Releases are excluded from the response <em>includeClosed=false</em> - Closed Release are included in the response [optional]

Return type

Array<ReleaseWithCustomFieldResource>

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

update

ReleaseWithCustomFieldResource update(project_id, release_id, body)

Updates a Release

To update a Release qTest Manager version: 6+

Example

# 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::ReleaseApi.new

project_id = 789 # Integer | ID of the project

release_id = 789 # Integer | ID of the Release which needs to be updated

body = SwaggerClient::ReleaseWithCustomFieldResource.new # ReleaseWithCustomFieldResource | The Release's updated properties


begin
  #Updates a Release
  result = api_instance.update(project_id, release_id, body)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReleaseApi->update: #{e}"
end

Parameters

Name Type Description Notes
project_id Integer ID of the project
release_id Integer ID of the Release which needs to be updated
body ReleaseWithCustomFieldResource The Release's updated properties

Return type

ReleaseWithCustomFieldResource

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined