Skip to content

Latest commit

 

History

History
515 lines (372 loc) · 13.5 KB

GLPathsApi.md

File metadata and controls

515 lines (372 loc) · 13.5 KB
Raw

ConnectWise::GLPathsApi

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

Method HTTP request Description
delete_finance_glpaths_by_id DELETE /finance/glpaths/{id} Delete GLPath
get_finance_glpaths GET /finance/glpaths Get List of GLPath
get_finance_glpaths_by_id GET /finance/glpaths/{id} Get GLPath
get_finance_glpaths_count GET /finance/glpaths/count Get Count of GLPath
patch_finance_glpaths_by_id PATCH /finance/glpaths/{id} Patch GLPath
post_finance_glpaths POST /finance/glpaths Post GLPath
put_finance_glpaths_by_id PUT /finance/glpaths/{id} Put GLPath

delete_finance_glpaths_by_id

delete_finance_glpaths_by_id(id, client_id)

Delete GLPath

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::GLPathsApi.new
id = 56 # Integer | glpathId
client_id = 'client_id_example' # String | 

begin
  # Delete GLPath
  api_instance.delete_finance_glpaths_by_id(id, client_id)
rescue ConnectWise::ApiError => e
  puts "Error when calling GLPathsApi->delete_finance_glpaths_by_id: #{e}"
end

Using the delete_finance_glpaths_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_finance_glpaths_by_id_with_http_info(id, client_id)

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

Parameters

Name Type Description Notes
id Integer glpathId
client_id String

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

get_finance_glpaths

<Array> get_finance_glpaths(client_id, opts)

Get List of GLPath

Examples

require 'time'
require 'connect_wise'

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

Using the get_finance_glpaths_with_http_info variant

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

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

begin
  # Get List of GLPath
  data, status_code, headers = api_instance.get_finance_glpaths_with_http_info(client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<GLPath>>
rescue ConnectWise::ApiError => e
  puts "Error when calling GLPathsApi->get_finance_glpaths_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<GLPath>

Authorization

No authorization required

HTTP request headers

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

get_finance_glpaths_by_id

get_finance_glpaths_by_id(id, client_id, opts)

Get GLPath

Examples

require 'time'
require 'connect_wise'

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

Using the get_finance_glpaths_by_id_with_http_info variant

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

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

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

Parameters

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

GLPath

Authorization

No authorization required

HTTP request headers

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

get_finance_glpaths_count

get_finance_glpaths_count(client_id, opts)

Get Count of GLPath

Examples

require 'time'
require 'connect_wise'

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

Using the get_finance_glpaths_count_with_http_info variant

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

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

begin
  # Get Count of GLPath
  data, status_code, headers = api_instance.get_finance_glpaths_count_with_http_info(client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Count>
rescue ConnectWise::ApiError => e
  puts "Error when calling GLPathsApi->get_finance_glpaths_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=2022.1

patch_finance_glpaths_by_id

patch_finance_glpaths_by_id(id, client_id, patch_operation)

Patch GLPath

Examples

require 'time'
require 'connect_wise'

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

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

Using the patch_finance_glpaths_by_id_with_http_info variant

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

<Array(, Integer, Hash)> patch_finance_glpaths_by_id_with_http_info(id, client_id, patch_operation)

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

Parameters

Name Type Description Notes
id Integer glpathId
client_id String
patch_operation Array<PatchOperation> List of PatchOperation

Return type

GLPath

Authorization

No authorization required

HTTP request headers

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

post_finance_glpaths

post_finance_glpaths(client_id, gl_path)

Post GLPath

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::GLPathsApi.new
client_id = 'client_id_example' # String | 
gl_path = ConnectWise::GLPath.new # GLPath | gLPath

begin
  # Post GLPath
  result = api_instance.post_finance_glpaths(client_id, gl_path)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling GLPathsApi->post_finance_glpaths: #{e}"
end

Using the post_finance_glpaths_with_http_info variant

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

<Array(, Integer, Hash)> post_finance_glpaths_with_http_info(client_id, gl_path)

begin
  # Post GLPath
  data, status_code, headers = api_instance.post_finance_glpaths_with_http_info(client_id, gl_path)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GLPath>
rescue ConnectWise::ApiError => e
  puts "Error when calling GLPathsApi->post_finance_glpaths_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
client_id String
gl_path GLPath gLPath

Return type

GLPath

Authorization

No authorization required

HTTP request headers

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

put_finance_glpaths_by_id

put_finance_glpaths_by_id(id, client_id, gl_path)

Put GLPath

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::GLPathsApi.new
id = 56 # Integer | glpathId
client_id = 'client_id_example' # String | 
gl_path = ConnectWise::GLPath.new # GLPath | gLPath

begin
  # Put GLPath
  result = api_instance.put_finance_glpaths_by_id(id, client_id, gl_path)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling GLPathsApi->put_finance_glpaths_by_id: #{e}"
end

Using the put_finance_glpaths_by_id_with_http_info variant

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

<Array(, Integer, Hash)> put_finance_glpaths_by_id_with_http_info(id, client_id, gl_path)

begin
  # Put GLPath
  data, status_code, headers = api_instance.put_finance_glpaths_by_id_with_http_info(id, client_id, gl_path)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GLPath>
rescue ConnectWise::ApiError => e
  puts "Error when calling GLPathsApi->put_finance_glpaths_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer glpathId
client_id String
gl_path GLPath gLPath

Return type

GLPath

Authorization

No authorization required

HTTP request headers

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