Skip to content

Latest commit

 

History

History
515 lines (372 loc) · 15.5 KB

ActivityStopwatchesApi.md

File metadata and controls

515 lines (372 loc) · 15.5 KB
Raw

ConnectWise::ActivityStopwatchesApi

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

Method HTTP request Description
delete_time_activitystopwatches_by_id DELETE /time/activitystopwatches/{id} Delete ActivityStopwatch
get_time_activitystopwatches GET /time/activitystopwatches Get List of ActivityStopwatch
get_time_activitystopwatches_by_id GET /time/activitystopwatches/{id} Get ActivityStopwatch
get_time_activitystopwatches_count GET /time/activitystopwatches/count Get Count of ActivityStopwatch
patch_time_activitystopwatches_by_id PATCH /time/activitystopwatches/{id} Patch ActivityStopwatch
post_time_activitystopwatches POST /time/activitystopwatches Post ActivityStopwatch
put_time_activitystopwatches_by_id PUT /time/activitystopwatches/{id} Put ActivityStopwatch

delete_time_activitystopwatches_by_id

delete_time_activitystopwatches_by_id(id, client_id)

Delete ActivityStopwatch

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ActivityStopwatchesApi.new
id = 56 # Integer | activitystopwatcheId
client_id = 'client_id_example' # String | 

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

Using the delete_time_activitystopwatches_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_time_activitystopwatches_by_id_with_http_info(id, client_id)

begin
  # Delete ActivityStopwatch
  data, status_code, headers = api_instance.delete_time_activitystopwatches_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 ActivityStopwatchesApi->delete_time_activitystopwatches_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer activitystopwatcheId
client_id String

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

get_time_activitystopwatches

<Array> get_time_activitystopwatches(client_id, opts)

Get List of ActivityStopwatch

Examples

require 'time'
require 'connect_wise'

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

Using the get_time_activitystopwatches_with_http_info variant

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

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

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

Authorization

No authorization required

HTTP request headers

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

get_time_activitystopwatches_by_id

get_time_activitystopwatches_by_id(id, client_id, opts)

Get ActivityStopwatch

Examples

require 'time'
require 'connect_wise'

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

Using the get_time_activitystopwatches_by_id_with_http_info variant

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

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

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

Parameters

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

ActivityStopwatch

Authorization

No authorization required

HTTP request headers

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

get_time_activitystopwatches_count

get_time_activitystopwatches_count(client_id, opts)

Get Count of ActivityStopwatch

Examples

require 'time'
require 'connect_wise'

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

Using the get_time_activitystopwatches_count_with_http_info variant

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

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

begin
  # Get Count of ActivityStopwatch
  data, status_code, headers = api_instance.get_time_activitystopwatches_count_with_http_info(client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Count>
rescue ConnectWise::ApiError => e
  puts "Error when calling ActivityStopwatchesApi->get_time_activitystopwatches_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_time_activitystopwatches_by_id

patch_time_activitystopwatches_by_id(id, client_id, patch_operation)

Patch ActivityStopwatch

Examples

require 'time'
require 'connect_wise'

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

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

Using the patch_time_activitystopwatches_by_id_with_http_info variant

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

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

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

Parameters

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

Return type

ActivityStopwatch

Authorization

No authorization required

HTTP request headers

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

post_time_activitystopwatches

post_time_activitystopwatches(client_id, activity_stopwatch)

Post ActivityStopwatch

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ActivityStopwatchesApi.new
client_id = 'client_id_example' # String | 
activity_stopwatch = ConnectWise::ActivityStopwatch.new({activity_id: 37, status: 'Reset'}) # ActivityStopwatch | activityStopwatch

begin
  # Post ActivityStopwatch
  result = api_instance.post_time_activitystopwatches(client_id, activity_stopwatch)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ActivityStopwatchesApi->post_time_activitystopwatches: #{e}"
end

Using the post_time_activitystopwatches_with_http_info variant

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

<Array(, Integer, Hash)> post_time_activitystopwatches_with_http_info(client_id, activity_stopwatch)

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

Parameters

Name Type Description Notes
client_id String
activity_stopwatch ActivityStopwatch activityStopwatch

Return type

ActivityStopwatch

Authorization

No authorization required

HTTP request headers

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

put_time_activitystopwatches_by_id

put_time_activitystopwatches_by_id(id, client_id, activity_stopwatch)

Put ActivityStopwatch

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ActivityStopwatchesApi.new
id = 56 # Integer | activitystopwatcheId
client_id = 'client_id_example' # String | 
activity_stopwatch = ConnectWise::ActivityStopwatch.new({activity_id: 37, status: 'Reset'}) # ActivityStopwatch | activityStopwatch

begin
  # Put ActivityStopwatch
  result = api_instance.put_time_activitystopwatches_by_id(id, client_id, activity_stopwatch)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ActivityStopwatchesApi->put_time_activitystopwatches_by_id: #{e}"
end

Using the put_time_activitystopwatches_by_id_with_http_info variant

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

<Array(, Integer, Hash)> put_time_activitystopwatches_by_id_with_http_info(id, client_id, activity_stopwatch)

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

Parameters

Name Type Description Notes
id Integer activitystopwatcheId
client_id String
activity_stopwatch ActivityStopwatch activityStopwatch

Return type

ActivityStopwatch

Authorization

No authorization required

HTTP request headers

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