Skip to content

Latest commit

 

History

History
413 lines (269 loc) · 10.2 KB

SubCategoriesApi.md

File metadata and controls

413 lines (269 loc) · 10.2 KB
Raw

Connectwise::SubCategoriesApi

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

Method HTTP request Description
procurement_categories_id_subcategories_count_get GET /procurement/categories/{id}/subcategories/count
procurement_categories_id_subcategories_get GET /procurement/categories/{id}/subcategories
procurement_categories_id_subcategories_post POST /procurement/categories/{id}/subcategories
procurement_categories_id_subcategories_subcategory_id_delete DELETE /procurement/categories/{id}/subcategories/{subcategoryID}
procurement_categories_id_subcategories_subcategory_id_get GET /procurement/categories/{id}/subcategories/{subcategoryID}
procurement_categories_id_subcategories_subcategory_id_patch PATCH /procurement/categories/{id}/subcategories/{subcategoryID}
procurement_categories_id_subcategories_subcategory_id_put PUT /procurement/categories/{id}/subcategories/{subcategoryID}

procurement_categories_id_subcategories_count_get

Count procurement_categories_id_subcategories_count_get(id, opts)

Get Sub Categories 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::SubCategoriesApi.new

id = 56 # Integer | 

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

begin
  result = api_instance.procurement_categories_id_subcategories_count_get(id, opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling SubCategoriesApi->procurement_categories_id_subcategories_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

procurement_categories_id_subcategories_get

Array<SubCategory> procurement_categories_id_subcategories_get(id, opts)

Get Sub Categories

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::SubCategoriesApi.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.procurement_categories_id_subcategories_get(id, opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling SubCategoriesApi->procurement_categories_id_subcategories_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<SubCategory>

Authorization

BasicAuth

HTTP request headers

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

procurement_categories_id_subcategories_post

SubCategory procurement_categories_id_subcategories_post(id, sub_category)

Create Sub Category

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

id = 56 # Integer | 

sub_category = Connectwise::SubCategory.new # SubCategory | 


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

Parameters

Name Type Description Notes
id Integer
sub_category SubCategory

Return type

SubCategory

Authorization

BasicAuth

HTTP request headers

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

procurement_categories_id_subcategories_subcategory_id_delete

procurement_categories_id_subcategories_subcategory_id_delete(id, subcategory_id)

Delete Sub Category 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::SubCategoriesApi.new

id = 56 # Integer | 

subcategory_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
subcategory_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

procurement_categories_id_subcategories_subcategory_id_get

SubCategory procurement_categories_id_subcategories_subcategory_id_get(id, subcategory_id)

Get Sub Category 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::SubCategoriesApi.new

id = 56 # Integer | 

subcategory_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
subcategory_id Integer

Return type

SubCategory

Authorization

BasicAuth

HTTP request headers

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

procurement_categories_id_subcategories_subcategory_id_patch

SubCategory procurement_categories_id_subcategories_subcategory_id_patch(id, subcategory_id, operations)

Update Sub Category

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

id = 56 # Integer | 

subcategory_id = 56 # Integer | 

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


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

Parameters

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

Return type

SubCategory

Authorization

BasicAuth

HTTP request headers

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

procurement_categories_id_subcategories_subcategory_id_put

SubCategory procurement_categories_id_subcategories_subcategory_id_put(id, subcategory_id, sub_category)

Replace Sub Category

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

id = 56 # Integer | 

subcategory_id = 56 # Integer | 

sub_category = Connectwise::SubCategory.new # SubCategory | 


begin
  result = api_instance.procurement_categories_id_subcategories_subcategory_id_put(id, subcategory_id, sub_category)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling SubCategoriesApi->procurement_categories_id_subcategories_subcategory_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
subcategory_id Integer
sub_category SubCategory

Return type

SubCategory

Authorization

BasicAuth

HTTP request headers

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