ConnectWise::CatalogComponentsApi

All URIs are relative to http://cloud.na.myconnectwise.net/v4_6_development/apis/3.0

Method	HTTP request	Description
delete_procurement_catalog_by_parent_id_components_by_id	DELETE /procurement/catalog/{parentId}/components/{id}	Delete CatalogComponent
get_procurement_catalog_by_parent_id_components	GET /procurement/catalog/{parentId}/components	Get List of CatalogComponent
get_procurement_catalog_by_parent_id_components_by_id	GET /procurement/catalog/{parentId}/components/{id}	Get CatalogComponent
get_procurement_catalog_by_parent_id_components_count	GET /procurement/catalog/{parentId}/components/count	Get Count of CatalogComponent
patch_procurement_catalog_by_parent_id_components_by_id	PATCH /procurement/catalog/{parentId}/components/{id}	Patch CatalogComponent
post_procurement_catalog_by_parent_id_components	POST /procurement/catalog/{parentId}/components	Post CatalogComponent
put_procurement_catalog_by_parent_id_components_by_id	PUT /procurement/catalog/{parentId}/components/{id}	Put CatalogComponent

delete_procurement_catalog_by_parent_id_components_by_id

delete_procurement_catalog_by_parent_id_components_by_id(id, parent_id, client_id)

Delete CatalogComponent

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CatalogComponentsApi.new
id = 56 # Integer | componentId
parent_id = 56 # Integer | catalogId
client_id = 'client_id_example' # String | 

begin
  # Delete CatalogComponent
  api_instance.delete_procurement_catalog_by_parent_id_components_by_id(id, parent_id, client_id)
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->delete_procurement_catalog_by_parent_id_components_by_id: #{e}"
end

Using the delete_procurement_catalog_by_parent_id_components_by_id_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_procurement_catalog_by_parent_id_components_by_id_with_http_info(id, parent_id, client_id)

begin
  # Delete CatalogComponent
  data, status_code, headers = api_instance.delete_procurement_catalog_by_parent_id_components_by_id_with_http_info(id, parent_id, client_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->delete_procurement_catalog_by_parent_id_components_by_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description
id	Integer	componentId
parent_id	Integer	catalogId
client_id	String

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

get_procurement_catalog_by_parent_id_components

<Array> get_procurement_catalog_by_parent_id_components(parent_id, client_id, opts)

Get List of CatalogComponent

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CatalogComponentsApi.new
parent_id = 56 # Integer | catalogId
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get List of CatalogComponent
  result = api_instance.get_procurement_catalog_by_parent_id_components(parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->get_procurement_catalog_by_parent_id_components: #{e}"
end

Using the get_procurement_catalog_by_parent_id_components_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> get_procurement_catalog_by_parent_id_components_with_http_info(parent_id, client_id, opts)

begin
  # Get List of CatalogComponent
  data, status_code, headers = api_instance.get_procurement_catalog_by_parent_id_components_with_http_info(parent_id, client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<CatalogComponent>>
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->get_procurement_catalog_by_parent_id_components_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
parent_id	Integer	catalogId
client_id	String
conditions	String		[optional]
child_conditions	String		[optional]
custom_field_conditions	String		[optional]
order_by	String		[optional]
fields	String		[optional]
page	Integer		[optional]
page_size	Integer		[optional]
page_id	Integer		[optional]

Return type

Array<CatalogComponent>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.connectwise.com+json; version=2022.1

get_procurement_catalog_by_parent_id_components_by_id

get_procurement_catalog_by_parent_id_components_by_id(id, parent_id, client_id, opts)

Get CatalogComponent

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CatalogComponentsApi.new
id = 56 # Integer | componentId
parent_id = 56 # Integer | catalogId
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get CatalogComponent
  result = api_instance.get_procurement_catalog_by_parent_id_components_by_id(id, parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->get_procurement_catalog_by_parent_id_components_by_id: #{e}"
end

Using the get_procurement_catalog_by_parent_id_components_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_procurement_catalog_by_parent_id_components_by_id_with_http_info(id, parent_id, client_id, opts)

begin
  # Get CatalogComponent
  data, status_code, headers = api_instance.get_procurement_catalog_by_parent_id_components_by_id_with_http_info(id, parent_id, client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CatalogComponent>
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->get_procurement_catalog_by_parent_id_components_by_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	componentId
parent_id	Integer	catalogId
client_id	String
conditions	String		[optional]
child_conditions	String		[optional]
custom_field_conditions	String		[optional]
order_by	String		[optional]
fields	String		[optional]
page	Integer		[optional]
page_size	Integer		[optional]
page_id	Integer		[optional]

Return type

CatalogComponent

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.connectwise.com+json; version=2022.1

get_procurement_catalog_by_parent_id_components_count

get_procurement_catalog_by_parent_id_components_count(parent_id, client_id, opts)

Get Count of CatalogComponent

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CatalogComponentsApi.new
parent_id = 56 # Integer | catalogId
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get Count of CatalogComponent
  result = api_instance.get_procurement_catalog_by_parent_id_components_count(parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->get_procurement_catalog_by_parent_id_components_count: #{e}"
end

Using the get_procurement_catalog_by_parent_id_components_count_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_procurement_catalog_by_parent_id_components_count_with_http_info(parent_id, client_id, opts)

begin
  # Get Count of CatalogComponent
  data, status_code, headers = api_instance.get_procurement_catalog_by_parent_id_components_count_with_http_info(parent_id, client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Count>
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->get_procurement_catalog_by_parent_id_components_count_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
parent_id	Integer	catalogId
client_id	String
conditions	String		[optional]
child_conditions	String		[optional]
custom_field_conditions	String		[optional]
order_by	String		[optional]
fields	String		[optional]
page	Integer		[optional]
page_size	Integer		[optional]
page_id	Integer		[optional]

Return type

Count

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.connectwise.com+json; version=2022.1

patch_procurement_catalog_by_parent_id_components_by_id

patch_procurement_catalog_by_parent_id_components_by_id(id, parent_id, client_id, patch_operation)

Patch CatalogComponent

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CatalogComponentsApi.new
id = 56 # Integer | componentId
parent_id = 56 # Integer | catalogId
client_id = 'client_id_example' # String | 
patch_operation = [ConnectWise::PatchOperation.new] # Array<PatchOperation> | List of PatchOperation

begin
  # Patch CatalogComponent
  result = api_instance.patch_procurement_catalog_by_parent_id_components_by_id(id, parent_id, client_id, patch_operation)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->patch_procurement_catalog_by_parent_id_components_by_id: #{e}"
end

Using the patch_procurement_catalog_by_parent_id_components_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> patch_procurement_catalog_by_parent_id_components_by_id_with_http_info(id, parent_id, client_id, patch_operation)

begin
  # Patch CatalogComponent
  data, status_code, headers = api_instance.patch_procurement_catalog_by_parent_id_components_by_id_with_http_info(id, parent_id, client_id, patch_operation)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CatalogComponent>
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->patch_procurement_catalog_by_parent_id_components_by_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description
id	Integer	componentId
parent_id	Integer	catalogId
client_id	String
patch_operation	Array<PatchOperation>	List of PatchOperation

Return type

CatalogComponent

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/vnd.connectwise.com+json; version=2022.1

post_procurement_catalog_by_parent_id_components

post_procurement_catalog_by_parent_id_components(parent_id, client_id, catalog_component)

Post CatalogComponent

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CatalogComponentsApi.new
parent_id = 56 # Integer | catalogId
client_id = 'client_id_example' # String | 
catalog_component = ConnectWise::CatalogComponent.new({quantity: 3.56}) # CatalogComponent | catalogComponent

begin
  # Post CatalogComponent
  result = api_instance.post_procurement_catalog_by_parent_id_components(parent_id, client_id, catalog_component)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->post_procurement_catalog_by_parent_id_components: #{e}"
end

Using the post_procurement_catalog_by_parent_id_components_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_procurement_catalog_by_parent_id_components_with_http_info(parent_id, client_id, catalog_component)

begin
  # Post CatalogComponent
  data, status_code, headers = api_instance.post_procurement_catalog_by_parent_id_components_with_http_info(parent_id, client_id, catalog_component)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CatalogComponent>
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->post_procurement_catalog_by_parent_id_components_with_http_info: #{e}"
end

Parameters

Name	Type	Description
parent_id	Integer	catalogId
client_id	String
catalog_component	CatalogComponent	catalogComponent

Return type

CatalogComponent

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/vnd.connectwise.com+json; version=2022.1

put_procurement_catalog_by_parent_id_components_by_id

put_procurement_catalog_by_parent_id_components_by_id(id, parent_id, client_id, catalog_component)

Put CatalogComponent

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CatalogComponentsApi.new
id = 56 # Integer | componentId
parent_id = 56 # Integer | catalogId
client_id = 'client_id_example' # String | 
catalog_component = ConnectWise::CatalogComponent.new({quantity: 3.56}) # CatalogComponent | catalogComponent

begin
  # Put CatalogComponent
  result = api_instance.put_procurement_catalog_by_parent_id_components_by_id(id, parent_id, client_id, catalog_component)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->put_procurement_catalog_by_parent_id_components_by_id: #{e}"
end

Using the put_procurement_catalog_by_parent_id_components_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> put_procurement_catalog_by_parent_id_components_by_id_with_http_info(id, parent_id, client_id, catalog_component)

begin
  # Put CatalogComponent
  data, status_code, headers = api_instance.put_procurement_catalog_by_parent_id_components_by_id_with_http_info(id, parent_id, client_id, catalog_component)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CatalogComponent>
rescue ConnectWise::ApiError => e
  puts "Error when calling CatalogComponentsApi->put_procurement_catalog_by_parent_id_components_by_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description
id	Integer	componentId
parent_id	Integer	catalogId
client_id	String
catalog_component	CatalogComponent	catalogComponent

Return type

CatalogComponent

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/vnd.connectwise.com+json; version=2022.1

Files

CatalogComponentsApi.md

Latest commit

History

CatalogComponentsApi.md

File metadata and controls

ConnectWise::CatalogComponentsApi

delete_procurement_catalog_by_parent_id_components_by_id

Examples

Using the delete_procurement_catalog_by_parent_id_components_by_id_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_procurement_catalog_by_parent_id_components

Examples

Using the get_procurement_catalog_by_parent_id_components_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_procurement_catalog_by_parent_id_components_by_id

Examples

Using the get_procurement_catalog_by_parent_id_components_by_id_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_procurement_catalog_by_parent_id_components_count

Examples

Using the get_procurement_catalog_by_parent_id_components_count_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

patch_procurement_catalog_by_parent_id_components_by_id

Examples

Using the patch_procurement_catalog_by_parent_id_components_by_id_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

post_procurement_catalog_by_parent_id_components

Examples

Using the post_procurement_catalog_by_parent_id_components_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

put_procurement_catalog_by_parent_id_components_by_id

Examples

Using the put_procurement_catalog_by_parent_id_components_by_id_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers