Skip to content

ParsingVariablesApi.md

Latest commit

 

History

History
252 lines (189 loc) · 7.5 KB

ParsingVariablesApi.md

File metadata and controls

252 lines (189 loc) · 7.5 KB

ConnectWise::ParsingVariablesApi

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

Method HTTP request Description
get_system_parsing_variables GET /system/parsingVariables Get List of ParsingVariable
get_system_parsing_variables_by_id GET /system/parsingVariables/{id} Get ParsingVariable
get_system_parsing_variables_count GET /system/parsingVariables/count Get Count of ParsingVariable

get_system_parsing_variables

<Array> get_system_parsing_variables(client_id, opts)

Get List of ParsingVariable

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ParsingVariablesApi.new
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 ParsingVariable
  result = api_instance.get_system_parsing_variables(client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ParsingVariablesApi->get_system_parsing_variables: #{e}"
end

Using the get_system_parsing_variables_with_http_info variant

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

<Array(<Array>, Integer, Hash)> get_system_parsing_variables_with_http_info(client_id, opts)

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

Parameters

Name Type Description Notes
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<ParsingVariable>

Authorization

No authorization required

HTTP request headers

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

get_system_parsing_variables_by_id

get_system_parsing_variables_by_id(id, client_id, opts)

Get ParsingVariable

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ParsingVariablesApi.new
id = 56 # Integer | parsingVariableId
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 ParsingVariable
  result = api_instance.get_system_parsing_variables_by_id(id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ParsingVariablesApi->get_system_parsing_variables_by_id: #{e}"
end

Using the get_system_parsing_variables_by_id_with_http_info variant

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

<Array(, Integer, Hash)> get_system_parsing_variables_by_id_with_http_info(id, client_id, opts)

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

Parameters

Name Type Description Notes
id Integer parsingVariableId
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

ParsingVariable

Authorization

No authorization required

HTTP request headers

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

get_system_parsing_variables_count

get_system_parsing_variables_count(client_id, opts)

Get Count of ParsingVariable

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ParsingVariablesApi.new
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 ParsingVariable
  result = api_instance.get_system_parsing_variables_count(client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ParsingVariablesApi->get_system_parsing_variables_count: #{e}"
end

Using the get_system_parsing_variables_count_with_http_info variant

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

<Array(, Integer, Hash)> get_system_parsing_variables_count_with_http_info(client_id, opts)

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

Parameters

Name Type Description Notes
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