Skip to content

Latest commit

 

History

History
350 lines (240 loc) · 7.51 KB

IssuesApi.md

File metadata and controls

350 lines (240 loc) · 7.51 KB

BmxApiRuby::IssuesApi

All URIs are relative to https://localhost:3000/api/v1

Method HTTP request Description
get_issues GET /issues List all issue ids
get_issues_detail GET /issues/detail List all issues details
get_issues_issue_exid GET /issues/{issue_exid} Show detail for one issue
get_issues_issue_exid_contracts GET /issues/{issue_exid}/contracts Show issue contracts
get_issues_issue_exid_offers GET /issues/{issue_exid}/offers Show issue offers
post_issues_exid POST /issues/{exid} Sync

get_issues

Array<IssueIds> get_issues(opts)

List all issue ids

List all issue ids

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::IssuesApi.new

opts = { 
  limit: 56 # Integer | count limit
}

begin
  #List all issue ids
  result = api_instance.get_issues(opts)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling IssuesApi->get_issues: #{e}"
end

Parameters

Name Type Description Notes
limit Integer count limit [optional]

Return type

Array<IssueIds>

Authorization

base

HTTP request headers

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

get_issues_detail

Array<IssueDetail> get_issues_detail(opts)

List all issues details

List all issues details

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::IssuesApi.new

opts = { 
  limit: 56 # Integer | count limit
}

begin
  #List all issues details
  result = api_instance.get_issues_detail(opts)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling IssuesApi->get_issues_detail: #{e}"
end

Parameters

Name Type Description Notes
limit Integer count limit [optional]

Return type

Array<IssueDetail>

Authorization

base

HTTP request headers

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

get_issues_issue_exid

IssueDetail get_issues_issue_exid(issue_exid)

Show detail for one issue

Show detail for one issue

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::IssuesApi.new

issue_exid = "issue_exid_example" # String | issue exid


begin
  #Show detail for one issue
  result = api_instance.get_issues_issue_exid(issue_exid)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling IssuesApi->get_issues_issue_exid: #{e}"
end

Parameters

Name Type Description Notes
issue_exid String issue exid

Return type

IssueDetail

Authorization

base

HTTP request headers

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

get_issues_issue_exid_contracts

Array<ContractDetail> get_issues_issue_exid_contracts(issue_exid)

Show issue contracts

Show issue contracts

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::IssuesApi.new

issue_exid = "issue_exid_example" # String | issue exid


begin
  #Show issue contracts
  result = api_instance.get_issues_issue_exid_contracts(issue_exid)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling IssuesApi->get_issues_issue_exid_contracts: #{e}"
end

Parameters

Name Type Description Notes
issue_exid String issue exid

Return type

Array<ContractDetail>

Authorization

base

HTTP request headers

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

get_issues_issue_exid_offers

Array<OfferDetail> get_issues_issue_exid_offers(issue_exid)

Show issue offers

Show issue offers

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::IssuesApi.new

issue_exid = "issue_exid_example" # String | issue exid


begin
  #Show issue offers
  result = api_instance.get_issues_issue_exid_offers(issue_exid)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling IssuesApi->get_issues_issue_exid_offers: #{e}"
end

Parameters

Name Type Description Notes
issue_exid String issue exid

Return type

Array<OfferDetail>

Authorization

base

HTTP request headers

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

post_issues_exid

IssueDetail post_issues_exid(exid, opts)

Sync

Sync

Example

# load the gem
require 'bmx_api_ruby'
# setup authorization
BmxApiRuby.configure do |config|
  # Configure HTTP basic authorization: base
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = BmxApiRuby::IssuesApi.new

exid = "exid_example" # String | issue exid

opts = { 
  tracker_uuid: "tracker_uuid_example", # String | tracker uuid
  issue_uuid: "issue_uuid_example", # String | issue uuid
  title: "title_example", # String | issue title
  status: "status_example", # String | issue status
  labels: "labels_example", # String | TBD
  xfields: "xfields_example", # String | TBD
  jfields: "jfields_example" # String | TBD
}

begin
  #Sync
  result = api_instance.post_issues_exid(exid, opts)
  p result
rescue BmxApiRuby::ApiError => e
  puts "Exception when calling IssuesApi->post_issues_exid: #{e}"
end

Parameters

Name Type Description Notes
exid String issue exid
tracker_uuid String tracker uuid [optional]
issue_uuid String issue uuid [optional]
title String issue title [optional]
status String issue status [optional]
labels String TBD [optional]
xfields String TBD [optional]
jfields String TBD [optional]

Return type

IssueDetail

Authorization

base

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json