Skip to content

Latest commit

 

History

History
392 lines (255 loc) · 7.73 KB

BoardsApi.md

File metadata and controls

392 lines (255 loc) · 7.73 KB
Raw

Connectwise::BoardsApi

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Method HTTP request Description
service_boards_count_get GET /service/boards/count
service_boards_get GET /service/boards
service_boards_id_delete DELETE /service/boards/{id}
service_boards_id_get GET /service/boards/{id}
service_boards_id_patch PATCH /service/boards/{id}
service_boards_id_put PUT /service/boards/{id}
service_boards_post POST /service/boards

service_boards_count_get

Count service_boards_count_get(opts)

Get Boards Count

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::BoardsApi.new

opts = { 
  conditions: "conditions_example" # String | 
}

begin
  result = api_instance.service_boards_count_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling BoardsApi->service_boards_count_get: #{e}"
end

Parameters

Name Type Description Notes
conditions String [optional]

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

service_boards_get

Array<Board> service_boards_get(opts)

Get Boards

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::BoardsApi.new

opts = { 
  conditions: "conditions_example" # String | 
  order_by: "order_by_example", # String | 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  result = api_instance.service_boards_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling BoardsApi->service_boards_get: #{e}"
end

Parameters

Name Type Description Notes
conditions String [optional]
order_by String [optional]
page Integer [optional]
page_size Integer [optional]

Return type

Array<Board>

Authorization

BasicAuth

HTTP request headers

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

service_boards_id_delete

service_boards_id_delete(id)

Delete Board By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::BoardsApi.new

id = 56 # Integer | 


begin
  api_instance.service_boards_id_delete(id)
rescue Connectwise::ApiError => e
  puts "Exception when calling BoardsApi->service_boards_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

service_boards_id_get

Board service_boards_id_get(id)

Get Board By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::BoardsApi.new

id = 56 # Integer | 


begin
  result = api_instance.service_boards_id_get(id)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling BoardsApi->service_boards_id_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer

Return type

Board

Authorization

BasicAuth

HTTP request headers

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

service_boards_id_patch

Board service_boards_id_patch(id, operations)

Update Board

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::BoardsApi.new

id = 56 # Integer | 

operations = [Connectwise::PatchOperation.new] # Array<PatchOperation> | 


begin
  result = api_instance.service_boards_id_patch(id, operations)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling BoardsApi->service_boards_id_patch: #{e}"
end

Parameters

Name Type Description Notes
id Integer
operations Array<PatchOperation>

Return type

Board

Authorization

BasicAuth

HTTP request headers

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

service_boards_id_put

Board service_boards_id_put(id, board)

Replace Board

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::BoardsApi.new

id = 56 # Integer | 

board = Connectwise::Board.new # Board | 


begin
  result = api_instance.service_boards_id_put(id, board)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling BoardsApi->service_boards_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
board Board

Return type

Board

Authorization

BasicAuth

HTTP request headers

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

service_boards_post

Board service_boards_post(board)

Create Board

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::BoardsApi.new

board = Connectwise::Board.new # Board | 


begin
  result = api_instance.service_boards_post(board)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling BoardsApi->service_boards_post: #{e}"
end

Parameters

Name Type Description Notes
board Board

Return type

Board

Authorization

BasicAuth

HTTP request headers

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