Skip to content

Latest commit

 

History

History
1290 lines (846 loc) · 27.7 KB

TicketsApi.md

File metadata and controls

1290 lines (846 loc) · 27.7 KB
Raw

Connectwise::TicketsApi

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

Method HTTP request Description
service_tickets_count_get GET /service/tickets/count
service_tickets_get GET /service/tickets
service_tickets_id_activities_count_get GET /service/tickets/{id}/activities/count
service_tickets_id_activities_get GET /service/tickets/{id}/activities
service_tickets_id_configurations_config_id_delete DELETE /service/tickets/{id}/configurations/{configId}
service_tickets_id_configurations_config_id_get GET /service/tickets/{id}/configurations/{configId}
service_tickets_id_configurations_count_get GET /service/tickets/{id}/configurations/count
service_tickets_id_configurations_get GET /service/tickets/{id}/configurations
service_tickets_id_configurations_post POST /service/tickets/{id}/configurations
service_tickets_id_delete DELETE /service/tickets/{id}
service_tickets_id_documents_count_get GET /service/tickets/{id}/documents/count
service_tickets_id_documents_get GET /service/tickets/{id}/documents
service_tickets_id_get GET /service/tickets/{id}
service_tickets_id_patch PATCH /service/tickets/{id}
service_tickets_id_products_count_get GET /service/tickets/{id}/products/count
service_tickets_id_products_get GET /service/tickets/{id}/products
service_tickets_id_put PUT /service/tickets/{id}
service_tickets_id_scheduleentries_count_get GET /service/tickets/{id}/scheduleentries/count
service_tickets_id_scheduleentries_get GET /service/tickets/{id}/scheduleentries
service_tickets_id_timeentries_count_get GET /service/tickets/{id}/timeentries/count
service_tickets_id_timeentries_get GET /service/tickets/{id}/timeentries
service_tickets_post POST /service/tickets
service_tickets_search_post POST /service/tickets/search

service_tickets_count_get

Count service_tickets_count_get(opts)

Get Tickets 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::TicketsApi.new

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

begin
  result = api_instance.service_tickets_count_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling TicketsApi->service_tickets_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_tickets_get

Array<Ticket> service_tickets_get(opts)

Get Tickets

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

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

begin
  result = api_instance.service_tickets_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling TicketsApi->service_tickets_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<Ticket>

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_activities_count_get

Count service_tickets_id_activities_count_get(id)

Get Ticket Activities 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::TicketsApi.new

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_activities_get

Array<ActivityReference> service_tickets_id_activities_get(id, opts)

Get Ticket Activities

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

id = 56 # Integer | 

opts = { 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

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

Parameters

Name Type Description Notes
id Integer
page Integer [optional]
page_size Integer [optional]

Return type

Array<ActivityReference>

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_configurations_config_id_delete

service_tickets_id_configurations_config_id_delete(id, config_id)

Delete Configuration Association

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

id = 56 # Integer | 

config_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
config_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_configurations_config_id_get

ConfigurationReference service_tickets_id_configurations_config_id_get(id, config_id)

Get Configuration Association

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

id = 56 # Integer | 

config_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
config_id Integer

Return type

ConfigurationReference

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_configurations_count_get

Count service_tickets_id_configurations_count_get(id)

Get Ticket Configurations 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::TicketsApi.new

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_configurations_get

Array<ConfigurationReference> service_tickets_id_configurations_get(id, opts)

Get Ticket Configurations

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

id = 56 # Integer | 

opts = { 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

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

Parameters

Name Type Description Notes
id Integer
page Integer [optional]
page_size Integer [optional]

Return type

Array<ConfigurationReference>

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_configurations_post

ConfigurationReference service_tickets_id_configurations_post(id, configuration)

Create Configuration Association

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

id = 56 # Integer | 

configuration = Connectwise::ConfigurationReference.new # ConfigurationReference | 


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

Parameters

Name Type Description Notes
id Integer
configuration ConfigurationReference

Return type

ConfigurationReference

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_delete

service_tickets_id_delete(id)

Delete Ticket 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::TicketsApi.new

id = 56 # Integer | 


begin
  api_instance.service_tickets_id_delete(id)
rescue Connectwise::ApiError => e
  puts "Exception when calling TicketsApi->service_tickets_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_tickets_id_documents_count_get

Count service_tickets_id_documents_count_get(id)

Get Ticket Documents 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::TicketsApi.new

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_documents_get

Array<DocumentReference> service_tickets_id_documents_get(id, opts)

Get Ticket Documents

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

id = 56 # Integer | 

opts = { 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

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

Parameters

Name Type Description Notes
id Integer
page Integer [optional]
page_size Integer [optional]

Return type

Array<DocumentReference>

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_get

Ticket service_tickets_id_get(id)

Get Ticket 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::TicketsApi.new

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

Ticket

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_patch

Ticket service_tickets_id_patch(id, operations)

Update Ticket

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

id = 56 # Integer | 

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


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

Parameters

Name Type Description Notes
id Integer
operations Array<PatchOperation>

Return type

Ticket

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_products_count_get

Count service_tickets_id_products_count_get(id)

Get Ticket Products 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::TicketsApi.new

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_products_get

Array<ProductReference> service_tickets_id_products_get(id, opts)

Get Ticket Products

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

id = 56 # Integer | 

opts = { 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

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

Parameters

Name Type Description Notes
id Integer
page Integer [optional]
page_size Integer [optional]

Return type

Array<ProductReference>

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_put

Ticket service_tickets_id_put(id, ticket)

Replace Ticket

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

id = 56 # Integer | 

ticket = Connectwise::Ticket.new # Ticket | 


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

Parameters

Name Type Description Notes
id Integer
ticket Ticket

Return type

Ticket

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_scheduleentries_count_get

Count service_tickets_id_scheduleentries_count_get(id)

Get Ticket Schedule Entries 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::TicketsApi.new

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_scheduleentries_get

Array<ScheduleEntryReference> service_tickets_id_scheduleentries_get(id, opts)

Get Ticket Schedule Entries

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

id = 56 # Integer | 

opts = { 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

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

Parameters

Name Type Description Notes
id Integer
page Integer [optional]
page_size Integer [optional]

Return type

Array<ScheduleEntryReference>

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_timeentries_count_get

Count service_tickets_id_timeentries_count_get(id)

Get Ticket Time Entries 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::TicketsApi.new

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

service_tickets_id_timeentries_get

Array<TimeEntryReference> service_tickets_id_timeentries_get(id, opts)

Get Ticket Time Entries

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

id = 56 # Integer | 

opts = { 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

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

Parameters

Name Type Description Notes
id Integer
page Integer [optional]
page_size Integer [optional]

Return type

Array<TimeEntryReference>

Authorization

BasicAuth

HTTP request headers

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

service_tickets_post

Ticket service_tickets_post(ticket)

Create Ticket

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

ticket = Connectwise::Ticket.new # Ticket | 


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

Parameters

Name Type Description Notes
ticket Ticket

Return type

Ticket

Authorization

BasicAuth

HTTP request headers

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

service_tickets_search_post

Array<Ticket> service_tickets_search_post(filter_values, opts)

Ticket Search

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

filter_values = Connectwise::FilterValues.new # FilterValues | 

opts = { 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

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

Parameters

Name Type Description Notes
filter_values FilterValues
page Integer [optional]
page_size Integer [optional]

Return type

Array<Ticket>

Authorization

BasicAuth

HTTP request headers

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