Skip to content

Latest commit

 

History

History
413 lines (269 loc) · 9.39 KB

ProjectPhasesApi.md

File metadata and controls

413 lines (269 loc) · 9.39 KB
Raw

Connectwise::ProjectPhasesApi

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

Method HTTP request Description
project_projects_id_phases_count_get GET /project/projects/{id}/phases/count
project_projects_id_phases_get GET /project/projects/{id}/phases
project_projects_id_phases_phase_id_delete DELETE /project/projects/{id}/phases/{phaseId}
project_projects_id_phases_phase_id_get GET /project/projects/{id}/phases/{phaseId}
project_projects_id_phases_phase_id_patch PATCH /project/projects/{id}/phases/{phaseId}
project_projects_id_phases_phase_id_put PUT /project/projects/{id}/phases/{phaseId}
project_projects_id_phases_post POST /project/projects/{id}/phases

project_projects_id_phases_count_get

Count project_projects_id_phases_count_get(id, opts)

Get Project Phases 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::ProjectPhasesApi.new

id = 56 # Integer | 

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

begin
  result = api_instance.project_projects_id_phases_count_get(id, opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProjectPhasesApi->project_projects_id_phases_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

project_projects_id_phases_get

Array<ProjectPhase> project_projects_id_phases_get(id, opts)

Get Project Phases

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

id = 56 # Integer | 

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

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

Parameters

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

Return type

Array<ProjectPhase>

Authorization

BasicAuth

HTTP request headers

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

project_projects_id_phases_phase_id_delete

project_projects_id_phases_phase_id_delete(id, phase_id)

Delete Project Phase 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::ProjectPhasesApi.new

id = 56 # Integer | 

phase_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
phase_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

project_projects_id_phases_phase_id_get

ProjectPhase project_projects_id_phases_phase_id_get(id, phase_id)

Get Project Phase 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::ProjectPhasesApi.new

id = 56 # Integer | 

phase_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
phase_id Integer

Return type

ProjectPhase

Authorization

BasicAuth

HTTP request headers

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

project_projects_id_phases_phase_id_patch

ProjectPhase project_projects_id_phases_phase_id_patch(id, phase_id, operations)

Update Project Phase

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

id = 56 # Integer | 

phase_id = 56 # Integer | 

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


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

Parameters

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

Return type

ProjectPhase

Authorization

BasicAuth

HTTP request headers

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

project_projects_id_phases_phase_id_put

ProjectPhase project_projects_id_phases_phase_id_put(id, phase_id, project_phase)

Replace Project Phase

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

id = 56 # Integer | 

phase_id = 56 # Integer | 

project_phase = Connectwise::ProjectPhase.new # ProjectPhase | 


begin
  result = api_instance.project_projects_id_phases_phase_id_put(id, phase_id, project_phase)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProjectPhasesApi->project_projects_id_phases_phase_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
phase_id Integer
project_phase ProjectPhase

Return type

ProjectPhase

Authorization

BasicAuth

HTTP request headers

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

project_projects_id_phases_post

ProjectPhase project_projects_id_phases_post(id, project_phase)

Create Project Phase

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

id = 56 # Integer | 

project_phase = Connectwise::ProjectPhase.new # ProjectPhase | 


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

Parameters

Name Type Description Notes
id Integer
project_phase ProjectPhase

Return type

ProjectPhase

Authorization

BasicAuth

HTTP request headers

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