Skip to content

CompanyCustomNotesApi.md

Latest commit

 

History

History
529 lines (386 loc) · 18.3 KB

CompanyCustomNotesApi.md

File metadata and controls

529 lines (386 loc) · 18.3 KB

ConnectWise::CompanyCustomNotesApi

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

Method HTTP request Description
delete_company_companies_by_parent_id_custom_status_notes_by_id DELETE /company/companies/{parentId}/customStatusNotes/{id} Delete CompanyCustomNote
get_company_companies_by_parent_id_custom_status_notes GET /company/companies/{parentId}/customStatusNotes Get List of CompanyCustomNote
get_company_companies_by_parent_id_custom_status_notes_by_id GET /company/companies/{parentId}/customStatusNotes/{id} Get CompanyCustomNote
get_company_companies_by_parent_id_custom_status_notes_count GET /company/companies/{parentId}/customStatusNotes/count Get Count of CompanyCustomNote
patch_company_companies_by_parent_id_custom_status_notes_by_id PATCH /company/companies/{parentId}/customStatusNotes/{id} Patch CompanyCustomNote
post_company_companies_by_parent_id_custom_status_notes POST /company/companies/{parentId}/customStatusNotes Post CompanyCustomNote
put_company_companies_by_parent_id_custom_status_notes_by_id PUT /company/companies/{parentId}/customStatusNotes/{id} Put CompanyCustomNote

delete_company_companies_by_parent_id_custom_status_notes_by_id

delete_company_companies_by_parent_id_custom_status_notes_by_id(id, parent_id, client_id)

Delete CompanyCustomNote

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CompanyCustomNotesApi.new
id = 56 # Integer | customStatusNoteId
parent_id = 56 # Integer | companyId
client_id = 'client_id_example' # String | 

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

Using the delete_company_companies_by_parent_id_custom_status_notes_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_company_companies_by_parent_id_custom_status_notes_by_id_with_http_info(id, parent_id, client_id)

begin
  # Delete CompanyCustomNote
  data, status_code, headers = api_instance.delete_company_companies_by_parent_id_custom_status_notes_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 CompanyCustomNotesApi->delete_company_companies_by_parent_id_custom_status_notes_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer customStatusNoteId
parent_id Integer companyId
client_id String

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

get_company_companies_by_parent_id_custom_status_notes

<Array> get_company_companies_by_parent_id_custom_status_notes(parent_id, client_id, opts)

Get List of CompanyCustomNote

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CompanyCustomNotesApi.new
parent_id = 56 # Integer | companyId
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 CompanyCustomNote
  result = api_instance.get_company_companies_by_parent_id_custom_status_notes(parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CompanyCustomNotesApi->get_company_companies_by_parent_id_custom_status_notes: #{e}"
end

Using the get_company_companies_by_parent_id_custom_status_notes_with_http_info variant

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

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

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

Parameters

Name Type Description Notes
parent_id Integer companyId
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<CompanyCustomNote>

Authorization

No authorization required

HTTP request headers

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

get_company_companies_by_parent_id_custom_status_notes_by_id

get_company_companies_by_parent_id_custom_status_notes_by_id(id, parent_id, client_id, opts)

Get CompanyCustomNote

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CompanyCustomNotesApi.new
id = 56 # Integer | customStatusNoteId
parent_id = 56 # Integer | companyId
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 CompanyCustomNote
  result = api_instance.get_company_companies_by_parent_id_custom_status_notes_by_id(id, parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CompanyCustomNotesApi->get_company_companies_by_parent_id_custom_status_notes_by_id: #{e}"
end

Using the get_company_companies_by_parent_id_custom_status_notes_by_id_with_http_info variant

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

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

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

Parameters

Name Type Description Notes
id Integer customStatusNoteId
parent_id Integer companyId
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

CompanyCustomNote

Authorization

No authorization required

HTTP request headers

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

get_company_companies_by_parent_id_custom_status_notes_count

get_company_companies_by_parent_id_custom_status_notes_count(parent_id, client_id, opts)

Get Count of CompanyCustomNote

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CompanyCustomNotesApi.new
parent_id = 56 # Integer | companyId
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 CompanyCustomNote
  result = api_instance.get_company_companies_by_parent_id_custom_status_notes_count(parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CompanyCustomNotesApi->get_company_companies_by_parent_id_custom_status_notes_count: #{e}"
end

Using the get_company_companies_by_parent_id_custom_status_notes_count_with_http_info variant

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

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

begin
  # Get Count of CompanyCustomNote
  data, status_code, headers = api_instance.get_company_companies_by_parent_id_custom_status_notes_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 CompanyCustomNotesApi->get_company_companies_by_parent_id_custom_status_notes_count_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
parent_id Integer companyId
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=2025.1

patch_company_companies_by_parent_id_custom_status_notes_by_id

patch_company_companies_by_parent_id_custom_status_notes_by_id(id, parent_id, client_id, patch_operation)

Patch CompanyCustomNote

Examples

require 'time'
require 'connect_wise'

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

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

Using the patch_company_companies_by_parent_id_custom_status_notes_by_id_with_http_info variant

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

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

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

Parameters

Name Type Description Notes
id Integer customStatusNoteId
parent_id Integer companyId
client_id String
patch_operation Array<PatchOperation> List of PatchOperation

Return type

CompanyCustomNote

Authorization

No authorization required

HTTP request headers

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

post_company_companies_by_parent_id_custom_status_notes

post_company_companies_by_parent_id_custom_status_notes(parent_id, client_id, company_custom_note)

Post CompanyCustomNote

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CompanyCustomNotesApi.new
parent_id = 56 # Integer | companyId
client_id = 'client_id_example' # String | 
company_custom_note = ConnectWise::CompanyCustomNote.new({custom_note: 'custom_note_example', status: ConnectWise::CompanyStatusReference.new}) # CompanyCustomNote | customNote

begin
  # Post CompanyCustomNote
  result = api_instance.post_company_companies_by_parent_id_custom_status_notes(parent_id, client_id, company_custom_note)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CompanyCustomNotesApi->post_company_companies_by_parent_id_custom_status_notes: #{e}"
end

Using the post_company_companies_by_parent_id_custom_status_notes_with_http_info variant

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

<Array(, Integer, Hash)> post_company_companies_by_parent_id_custom_status_notes_with_http_info(parent_id, client_id, company_custom_note)

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

Parameters

Name Type Description Notes
parent_id Integer companyId
client_id String
company_custom_note CompanyCustomNote customNote

Return type

CompanyCustomNote

Authorization

No authorization required

HTTP request headers

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

put_company_companies_by_parent_id_custom_status_notes_by_id

put_company_companies_by_parent_id_custom_status_notes_by_id(id, parent_id, client_id, company_custom_note)

Put CompanyCustomNote

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CompanyCustomNotesApi.new
id = 56 # Integer | customStatusNoteId
parent_id = 56 # Integer | companyId
client_id = 'client_id_example' # String | 
company_custom_note = ConnectWise::CompanyCustomNote.new({custom_note: 'custom_note_example', status: ConnectWise::CompanyStatusReference.new}) # CompanyCustomNote | customNote

begin
  # Put CompanyCustomNote
  result = api_instance.put_company_companies_by_parent_id_custom_status_notes_by_id(id, parent_id, client_id, company_custom_note)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CompanyCustomNotesApi->put_company_companies_by_parent_id_custom_status_notes_by_id: #{e}"
end

Using the put_company_companies_by_parent_id_custom_status_notes_by_id_with_http_info variant

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

<Array(, Integer, Hash)> put_company_companies_by_parent_id_custom_status_notes_by_id_with_http_info(id, parent_id, client_id, company_custom_note)

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

Parameters

Name Type Description Notes
id Integer customStatusNoteId
parent_id Integer companyId
client_id String
company_custom_note CompanyCustomNote customNote

Return type

CompanyCustomNote

Authorization

No authorization required

HTTP request headers

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