Skip to content

Latest commit

 

History

History
450 lines (294 loc) · 9.39 KB

PrioritiesApi.md

File metadata and controls

450 lines (294 loc) · 9.39 KB
Raw

Connectwise::PrioritiesApi

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

Method HTTP request Description
service_priorities_count_get GET /service/priorities/count
service_priorities_get GET /service/priorities
service_priorities_id_delete DELETE /service/priorities/{id}
service_priorities_id_get GET /service/priorities/{id}
service_priorities_id_image_get GET /service/priorities/{id}/image
service_priorities_id_patch PATCH /service/priorities/{id}
service_priorities_id_put PUT /service/priorities/{id}
service_priorities_post POST /service/priorities

service_priorities_count_get

Count service_priorities_count_get(opts)

Create Priorities 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::PrioritiesApi.new

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

begin
  result = api_instance.service_priorities_count_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling PrioritiesApi->service_priorities_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

service_priorities_get

Array<Priority> service_priorities_get(opts)

Get Priorities

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

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

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

Parameters

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

Return type

Array<Priority>

Authorization

BasicAuth

HTTP request headers

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

service_priorities_id_delete

service_priorities_id_delete(id)

Delete Priority 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::PrioritiesApi.new

id = 56 # Integer | 


begin
  api_instance.service_priorities_id_delete(id)
rescue Connectwise::ApiError => e
  puts "Exception when calling PrioritiesApi->service_priorities_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

service_priorities_id_get

Priority service_priorities_id_get(id)

Get Priority 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::PrioritiesApi.new

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

Priority

Authorization

BasicAuth

HTTP request headers

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

service_priorities_id_image_get

service_priorities_id_image_get(id, opts)

Get Priority Image

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

id = 56 # Integer | 

opts = { 
  use_default_flag: true, # BOOLEAN | 
  last_modified: "last_modified_example" # String | 
}

begin
  api_instance.service_priorities_id_image_get(id, opts)
rescue Connectwise::ApiError => e
  puts "Exception when calling PrioritiesApi->service_priorities_id_image_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer
use_default_flag BOOLEAN [optional]
last_modified String [optional]

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

service_priorities_id_patch

Priority service_priorities_id_patch(id, operations)

Update Priority

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

id = 56 # Integer | 

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


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

Parameters

Name Type Description Notes
id Integer
operations Array<PatchOperation>

Return type

Priority

Authorization

BasicAuth

HTTP request headers

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

service_priorities_id_put

Priority service_priorities_id_put(id, priority)

Replace Priority

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

id = 56 # Integer | 

priority = Connectwise::Priority.new # Priority | 


begin
  result = api_instance.service_priorities_id_put(id, priority)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling PrioritiesApi->service_priorities_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
priority Priority

Return type

Priority

Authorization

BasicAuth

HTTP request headers

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

service_priorities_post

Priority service_priorities_post(priority)

Create Priority

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

priority = Connectwise::Priority.new # Priority | 


begin
  result = api_instance.service_priorities_post(priority)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling PrioritiesApi->service_priorities_post: #{e}"
end

Parameters

Name Type Description Notes
priority Priority

Return type

Priority

Authorization

BasicAuth

HTTP request headers

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