Skip to content

Latest commit

 

History

History
413 lines (269 loc) · 9.28 KB

BoardSubTypesApi.md

File metadata and controls

413 lines (269 loc) · 9.28 KB
Raw

Connectwise::BoardSubTypesApi

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

Method HTTP request Description
service_boards_id_subtypes_count_get GET /service/boards/{id}/subtypes/count
service_boards_id_subtypes_get GET /service/boards/{id}/subtypes
service_boards_id_subtypes_post POST /service/boards/{id}/subtypes
service_boards_id_subtypes_subtype_id_delete DELETE /service/boards/{id}/subtypes/{subtypeId}
service_boards_id_subtypes_subtype_id_get GET /service/boards/{id}/subtypes/{subtypeId}
service_boards_id_subtypes_subtype_id_patch PATCH /service/boards/{id}/subtypes/{subtypeId}
service_boards_id_subtypes_subtype_id_put PUT /service/boards/{id}/subtypes/{subtypeId}

service_boards_id_subtypes_count_get

Count service_boards_id_subtypes_count_get(id, opts)

Get Subtypes 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::BoardSubTypesApi.new

id = 56 # Integer | 

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

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

Parameters

Name Type Description Notes
id Integer
conditions String [optional]

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

service_boards_id_subtypes_get

Array<SubType> service_boards_id_subtypes_get(id, opts)

Get Subtypes

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::BoardSubTypesApi.new

id = 56 # Integer | 

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

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

Parameters

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

Return type

Array<SubType>

Authorization

BasicAuth

HTTP request headers

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

service_boards_id_subtypes_post

SubType service_boards_id_subtypes_post(id, sub_type)

Create Subtype

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::BoardSubTypesApi.new

id = 56 # Integer | 

sub_type = Connectwise::SubType.new # SubType | 


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

Parameters

Name Type Description Notes
id Integer
sub_type SubType

Return type

SubType

Authorization

BasicAuth

HTTP request headers

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

service_boards_id_subtypes_subtype_id_delete

service_boards_id_subtypes_subtype_id_delete(id, subtype_id)

Delete Subtype 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::BoardSubTypesApi.new

id = 56 # Integer | 

subtype_id = 56 # Integer | 


begin
  api_instance.service_boards_id_subtypes_subtype_id_delete(id, subtype_id)
rescue Connectwise::ApiError => e
  puts "Exception when calling BoardSubTypesApi->service_boards_id_subtypes_subtype_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer
subtype_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

service_boards_id_subtypes_subtype_id_get

SubType service_boards_id_subtypes_subtype_id_get(id, subtype_id)

Get Subtype 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::BoardSubTypesApi.new

id = 56 # Integer | 

subtype_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
subtype_id Integer

Return type

SubType

Authorization

BasicAuth

HTTP request headers

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

service_boards_id_subtypes_subtype_id_patch

SubType service_boards_id_subtypes_subtype_id_patch(id, subtype_id, operations)

Update Subtype

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::BoardSubTypesApi.new

id = 56 # Integer | 

subtype_id = 56 # Integer | 

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


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

Parameters

Name Type Description Notes
id Integer
subtype_id Integer
operations Array<PatchOperation>

Return type

SubType

Authorization

BasicAuth

HTTP request headers

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

service_boards_id_subtypes_subtype_id_put

SubType service_boards_id_subtypes_subtype_id_put(id, subtype_id, sub_type)

Replace Subtype

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::BoardSubTypesApi.new

id = 56 # Integer | 

subtype_id = 56 # Integer | 

sub_type = Connectwise::SubType.new # SubType | 


begin
  result = api_instance.service_boards_id_subtypes_subtype_id_put(id, subtype_id, sub_type)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling BoardSubTypesApi->service_boards_id_subtypes_subtype_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
subtype_id Integer
sub_type SubType

Return type

SubType

Authorization

BasicAuth

HTTP request headers

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