Skip to content

Latest commit

 

History

History
417 lines (273 loc) · 10.6 KB

AgreementTypeWorkRolesApi.md

File metadata and controls

417 lines (273 loc) · 10.6 KB
Raw

ConnectWise::AgreementTypeWorkRolesApi

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

Method HTTP request Description
finance_agreement_types_id_workroles_count_get GET /finance/agreementTypes/{id}/workroles/count
finance_agreement_types_id_workroles_get GET /finance/agreementTypes/{id}/workroles
finance_agreement_types_id_workroles_post POST /finance/agreementTypes/{id}/workroles
finance_agreement_types_id_workroles_work_role_id_delete DELETE /finance/agreementTypes/{id}/workroles/{workRoleId}
finance_agreement_types_id_workroles_work_role_id_get GET /finance/agreementTypes/{id}/workroles/{workRoleId}
finance_agreement_types_id_workroles_work_role_id_patch PATCH /finance/agreementTypes/{id}/workroles/{workRoleId}
finance_agreement_types_id_workroles_work_role_id_put PUT /finance/agreementTypes/{id}/workroles/{workRoleId}

finance_agreement_types_id_workroles_count_get

Count finance_agreement_types_id_workroles_count_get(id, opts)

Get Work Roles 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::AgreementTypeWorkRolesApi.new

id = 56 # Integer | 

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

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

Parameters

Name Type Description Notes
id Integer
conditions String [optional]

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

finance_agreement_types_id_workroles_get

Array<AgreementTypeWorkRole> finance_agreement_types_id_workroles_get(id, opts)

Get Work Roles

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

id = 56 # Integer | 

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.finance_agreement_types_id_workroles_get(id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling AgreementTypeWorkRolesApi->finance_agreement_types_id_workroles_get: #{e}"
end

Parameters

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

Return type

Array<AgreementTypeWorkRole>

Authorization

BasicAuth

HTTP request headers

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

finance_agreement_types_id_workroles_post

AgreementTypeWorkRole finance_agreement_types_id_workroles_post(id, work_role)

Create Work Role

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

id = 56 # Integer | 

work_role = ConnectWise::AgreementTypeWorkRole.new # AgreementTypeWorkRole | 


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

Parameters

Name Type Description Notes
id Integer
work_role AgreementTypeWorkRole

Return type

AgreementTypeWorkRole

Authorization

BasicAuth

HTTP request headers

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

finance_agreement_types_id_workroles_work_role_id_delete

finance_agreement_types_id_workroles_work_role_id_delete(id, work_role_id)

Delete Work Role 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::AgreementTypeWorkRolesApi.new

id = 56 # Integer | 

work_role_id = 56 # Integer | 


begin
  api_instance.finance_agreement_types_id_workroles_work_role_id_delete(id, work_role_id)
rescue ConnectWise::ApiError => e
  puts "Exception when calling AgreementTypeWorkRolesApi->finance_agreement_types_id_workroles_work_role_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer
work_role_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

finance_agreement_types_id_workroles_work_role_id_get

AgreementTypeWorkRole finance_agreement_types_id_workroles_work_role_id_get(id, work_role_id)

Get Work Role 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::AgreementTypeWorkRolesApi.new

id = 56 # Integer | 

work_role_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
work_role_id Integer

Return type

AgreementTypeWorkRole

Authorization

BasicAuth

HTTP request headers

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

finance_agreement_types_id_workroles_work_role_id_patch

AgreementTypeWorkRole finance_agreement_types_id_workroles_work_role_id_patch(id, work_role_id, operations)

Update Work Role

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

id = 56 # Integer | 

work_role_id = 56 # Integer | 

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


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

Parameters

Name Type Description Notes
id Integer
work_role_id Integer
operations Array<PatchOperation>

Return type

AgreementTypeWorkRole

Authorization

BasicAuth

HTTP request headers

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

finance_agreement_types_id_workroles_work_role_id_put

AgreementTypeWorkRole finance_agreement_types_id_workroles_work_role_id_put(id, work_role_id, work_role)

Replace Work Role

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

id = 56 # Integer | 

work_role_id = 56 # Integer | 

work_role = ConnectWise::AgreementTypeWorkRole.new # AgreementTypeWorkRole | 


begin
  result = api_instance.finance_agreement_types_id_workroles_work_role_id_put(id, work_role_id, work_role)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling AgreementTypeWorkRolesApi->finance_agreement_types_id_workroles_work_role_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
work_role_id Integer
work_role AgreementTypeWorkRole

Return type

AgreementTypeWorkRole

Authorization

BasicAuth

HTTP request headers

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