Skip to content

Latest commit

 

History

History
396 lines (259 loc) · 7.81 KB

LinksApi.md

File metadata and controls

396 lines (259 loc) · 7.81 KB
Raw

ConnectWise::LinksApi

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

Method HTTP request Description
system_links_count_get GET /system/links/count
system_links_get GET /system/links
system_links_id_delete DELETE /system/links/{id}
system_links_id_get GET /system/links/{id}
system_links_id_patch PATCH /system/links/{id}
system_links_id_put PUT /system/links/{id}
system_links_post POST /system/links

system_links_count_get

Count system_links_count_get(opts)

Get Links 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::LinksApi.new

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

begin
  result = api_instance.system_links_count_get(opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling LinksApi->system_links_count_get: #{e}"
end

Parameters

Name Type Description Notes
conditions String [optional]

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

system_links_get

Array<Link> system_links_get(opts)

Get Links

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

opts = { 
  conditions: "conditions_example" # String | 
  order_by: "order_by_example", # String | 
  childconditions: "childconditions_example", # String | 
  customfieldconditions: "customfieldconditions_example", # String | 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  result = api_instance.system_links_get(opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling LinksApi->system_links_get: #{e}"
end

Parameters

Name Type Description Notes
conditions String [optional]
order_by String [optional]
childconditions String [optional]
customfieldconditions String [optional]
page Integer [optional]
page_size Integer [optional]

Return type

Array<Link>

Authorization

BasicAuth

HTTP request headers

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

system_links_id_delete

system_links_id_delete(id)

Delete Link 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::LinksApi.new

id = 56 # Integer | 


begin
  api_instance.system_links_id_delete(id)
rescue ConnectWise::ApiError => e
  puts "Exception when calling LinksApi->system_links_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

system_links_id_get

Link system_links_id_get(id)

Get Link 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::LinksApi.new

id = 56 # Integer | 


begin
  result = api_instance.system_links_id_get(id)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling LinksApi->system_links_id_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer

Return type

Link

Authorization

BasicAuth

HTTP request headers

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

system_links_id_patch

Link system_links_id_patch(id, operations)

Update Link

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

id = 56 # Integer | 

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


begin
  result = api_instance.system_links_id_patch(id, operations)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling LinksApi->system_links_id_patch: #{e}"
end

Parameters

Name Type Description Notes
id Integer
operations Array<PatchOperation>

Return type

Link

Authorization

BasicAuth

HTTP request headers

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

system_links_id_put

Link system_links_id_put(id, link)

Replace Link

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

id = 56 # Integer | 

link = ConnectWise::Link.new # Link | 


begin
  result = api_instance.system_links_id_put(id, link)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling LinksApi->system_links_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
link Link

Return type

Link

Authorization

BasicAuth

HTTP request headers

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

system_links_post

Link system_links_post(link)

Create Link

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

link = ConnectWise::Link.new # Link | 


begin
  result = api_instance.system_links_post(link)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling LinksApi->system_links_post: #{e}"
end

Parameters

Name Type Description Notes
link Link

Return type

Link

Authorization

BasicAuth

HTTP request headers

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