Skip to content

Latest commit

 

History

History
413 lines (269 loc) · 10.1 KB

CatalogComponentsApi.md

File metadata and controls

413 lines (269 loc) · 10.1 KB

Connectwise::CatalogComponentsApi

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

Method HTTP request Description
procurement_catalog_id_components_component_id_delete DELETE /procurement/catalog/{id}/components/{componentId}
procurement_catalog_id_components_component_id_get GET /procurement/catalog/{id}/components/{componentId}
procurement_catalog_id_components_component_id_patch PATCH /procurement/catalog/{id}/components/{componentId}
procurement_catalog_id_components_component_id_put PUT /procurement/catalog/{id}/components/{componentId}
procurement_catalog_id_components_count_get GET /procurement/catalog/{id}/components/count
procurement_catalog_id_components_get GET /procurement/catalog/{id}/components
procurement_catalog_id_components_post POST /procurement/catalog/{id}/components

procurement_catalog_id_components_component_id_delete

procurement_catalog_id_components_component_id_delete(id, component_id)

Delete Catalog Component 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::CatalogComponentsApi.new

id = 56 # Integer | 

component_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
component_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

procurement_catalog_id_components_component_id_get

CatalogComponent procurement_catalog_id_components_component_id_get(id, component_id)

Get Catalog Component 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::CatalogComponentsApi.new

id = 56 # Integer | 

component_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
component_id Integer

Return type

CatalogComponent

Authorization

BasicAuth

HTTP request headers

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

procurement_catalog_id_components_component_id_patch

CatalogComponent procurement_catalog_id_components_component_id_patch(id, component_id, operations)

Update Catalog Component

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

id = 56 # Integer | 

component_id = 56 # Integer | 

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


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

Parameters

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

Return type

CatalogComponent

Authorization

BasicAuth

HTTP request headers

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

procurement_catalog_id_components_component_id_put

CatalogComponent procurement_catalog_id_components_component_id_put(id, component_id, catalog_component)

Replace Catalog Component

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

id = 56 # Integer | 

component_id = 56 # Integer | 

catalog_component = Connectwise::CatalogComponent.new # CatalogComponent | 


begin
  result = api_instance.procurement_catalog_id_components_component_id_put(id, component_id, catalog_component)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CatalogComponentsApi->procurement_catalog_id_components_component_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
component_id Integer
catalog_component CatalogComponent

Return type

CatalogComponent

Authorization

BasicAuth

HTTP request headers

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

procurement_catalog_id_components_count_get

Count procurement_catalog_id_components_count_get(id, opts)

Get Catalog Components 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::CatalogComponentsApi.new

id = 56 # Integer | 

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

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

Array<CatalogComponent> procurement_catalog_id_components_get(id, opts)

Get Catalog Components

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::CatalogComponentsApi.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_catalog_id_components_get(id, opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CatalogComponentsApi->procurement_catalog_id_components_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<CatalogComponent>

Authorization

BasicAuth

HTTP request headers

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

procurement_catalog_id_components_post

CatalogComponent procurement_catalog_id_components_post(id, catalog_component)

Create Catalog Component

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

id = 56 # Integer | 

catalog_component = Connectwise::CatalogComponent.new # CatalogComponent | 


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

Parameters

Name Type Description Notes
id Integer
catalog_component CatalogComponent

Return type

CatalogComponent

Authorization

BasicAuth

HTTP request headers

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