Skip to content

ProjectsApi.md

Latest commit

 

History

History
732 lines (529 loc) · 20.9 KB

ProjectsApi.md

File metadata and controls

732 lines (529 loc) · 20.9 KB

ConnectWise::ProjectsApi

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

Method HTTP request Description
delete_project_projects_by_id DELETE /project/projects/{id} Delete ApiProject
get_project_projects GET /project/projects Get List of ApiProject
get_project_projects_by_id GET /project/projects/{id} Get ApiProject
get_project_projects_by_id_project_workplan GET /project/projects/{id}/projectWorkplan Get ProjectWorkplan
get_project_projects_count GET /project/projects/count Get Count of ApiProject
patch_project_projects_by_id PATCH /project/projects/{id} Patch ApiProject
post_project_projects POST /project/projects Post ApiProject
post_project_projects_by_parent_id_apply_template_by_id POST /project/projects/{parentId}/applyTemplate/{id} Post ApplyTemplate
post_project_projects_by_parent_id_apply_templates POST /project/projects/{parentId}/applyTemplates Post ApplyTemplates
put_project_projects_by_id PUT /project/projects/{id} Put ApiProject

delete_project_projects_by_id

delete_project_projects_by_id(id, client_id)

Delete ApiProject

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ProjectsApi.new
id = 56 # Integer | projectId
client_id = 'client_id_example' # String | 

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

Using the delete_project_projects_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_project_projects_by_id_with_http_info(id, client_id)

begin
  # Delete ApiProject
  data, status_code, headers = api_instance.delete_project_projects_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 ProjectsApi->delete_project_projects_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer projectId
client_id String

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

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

get_project_projects

<Array> get_project_projects(client_id, opts)

Get List of ApiProject

Examples

require 'time'
require 'connect_wise'

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

Using the get_project_projects_with_http_info variant

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

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

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

Authorization

No authorization required

HTTP request headers

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

get_project_projects_by_id

get_project_projects_by_id(id, client_id, opts)

Get ApiProject

Examples

require 'time'
require 'connect_wise'

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

Using the get_project_projects_by_id_with_http_info variant

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

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

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

Parameters

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

Project

Authorization

No authorization required

HTTP request headers

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

get_project_projects_by_id_project_workplan

get_project_projects_by_id_project_workplan(id, client_id, opts)

Get ProjectWorkplan

Examples

require 'time'
require 'connect_wise'

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

Using the get_project_projects_by_id_project_workplan_with_http_info variant

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

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

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

Parameters

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

ProjectWorkplan

Authorization

No authorization required

HTTP request headers

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

get_project_projects_count

get_project_projects_count(client_id, opts)

Get Count of ApiProject

Examples

require 'time'
require 'connect_wise'

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

Using the get_project_projects_count_with_http_info variant

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

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

begin
  # Get Count of ApiProject
  data, status_code, headers = api_instance.get_project_projects_count_with_http_info(client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Count>
rescue ConnectWise::ApiError => e
  puts "Error when calling ProjectsApi->get_project_projects_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=2025.1

patch_project_projects_by_id

patch_project_projects_by_id(id, client_id, patch_operation)

Patch ApiProject

Examples

require 'time'
require 'connect_wise'

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

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

Using the patch_project_projects_by_id_with_http_info variant

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

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

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

Parameters

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

Return type

Project

Authorization

No authorization required

HTTP request headers

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

post_project_projects

post_project_projects(client_id, project)

Post ApiProject

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ProjectsApi.new
client_id = 'client_id_example' # String | 
project = ConnectWise::Project.new({billing_method: 'ActualRates', board: ConnectWise::ProjectBoardReference.new, company: ConnectWise::CompanyReference.new, estimated_end: Time.now, estimated_start: Time.now, name: 'name_example'}) # Project | project

begin
  # Post ApiProject
  result = api_instance.post_project_projects(client_id, project)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ProjectsApi->post_project_projects: #{e}"
end

Using the post_project_projects_with_http_info variant

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

<Array(, Integer, Hash)> post_project_projects_with_http_info(client_id, project)

begin
  # Post ApiProject
  data, status_code, headers = api_instance.post_project_projects_with_http_info(client_id, project)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Project>
rescue ConnectWise::ApiError => e
  puts "Error when calling ProjectsApi->post_project_projects_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
client_id String
project Project project

Return type

Project

Authorization

No authorization required

HTTP request headers

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

post_project_projects_by_parent_id_apply_template_by_id

post_project_projects_by_parent_id_apply_template_by_id(id, parent_id, client_id)

Post ApplyTemplate

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ProjectsApi.new
id = 56 # Integer | templateProjectId
parent_id = 56 # Integer | projectId
client_id = 'client_id_example' # String | 

begin
  # Post ApplyTemplate
  result = api_instance.post_project_projects_by_parent_id_apply_template_by_id(id, parent_id, client_id)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ProjectsApi->post_project_projects_by_parent_id_apply_template_by_id: #{e}"
end

Using the post_project_projects_by_parent_id_apply_template_by_id_with_http_info variant

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

<Array(, Integer, Hash)> post_project_projects_by_parent_id_apply_template_by_id_with_http_info(id, parent_id, client_id)

begin
  # Post ApplyTemplate
  data, status_code, headers = api_instance.post_project_projects_by_parent_id_apply_template_by_id_with_http_info(id, parent_id, client_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ProjectWorkplan>
rescue ConnectWise::ApiError => e
  puts "Error when calling ProjectsApi->post_project_projects_by_parent_id_apply_template_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer templateProjectId
parent_id Integer projectId
client_id String

Return type

ProjectWorkplan

Authorization

No authorization required

HTTP request headers

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

post_project_projects_by_parent_id_apply_templates

post_project_projects_by_parent_id_apply_templates(parent_id, client_id, project_template)

Post ApplyTemplates

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ProjectsApi.new
parent_id = 56 # Integer | projectId
client_id = 'client_id_example' # String | 
project_template = [ConnectWise::ProjectTemplate.new({name: 'name_example'})] # Array<ProjectTemplate> | List of Project Templates

begin
  # Post ApplyTemplates
  result = api_instance.post_project_projects_by_parent_id_apply_templates(parent_id, client_id, project_template)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ProjectsApi->post_project_projects_by_parent_id_apply_templates: #{e}"
end

Using the post_project_projects_by_parent_id_apply_templates_with_http_info variant

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

<Array(, Integer, Hash)> post_project_projects_by_parent_id_apply_templates_with_http_info(parent_id, client_id, project_template)

begin
  # Post ApplyTemplates
  data, status_code, headers = api_instance.post_project_projects_by_parent_id_apply_templates_with_http_info(parent_id, client_id, project_template)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ProjectWorkplan>
rescue ConnectWise::ApiError => e
  puts "Error when calling ProjectsApi->post_project_projects_by_parent_id_apply_templates_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
parent_id Integer projectId
client_id String
project_template Array<ProjectTemplate> List of Project Templates

Return type

ProjectWorkplan

Authorization

No authorization required

HTTP request headers

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

put_project_projects_by_id

put_project_projects_by_id(id, client_id, project)

Put ApiProject

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::ProjectsApi.new
id = 56 # Integer | projectId
client_id = 'client_id_example' # String | 
project = ConnectWise::Project.new({billing_method: 'ActualRates', board: ConnectWise::ProjectBoardReference.new, company: ConnectWise::CompanyReference.new, estimated_end: Time.now, estimated_start: Time.now, name: 'name_example'}) # Project | project

begin
  # Put ApiProject
  result = api_instance.put_project_projects_by_id(id, client_id, project)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling ProjectsApi->put_project_projects_by_id: #{e}"
end

Using the put_project_projects_by_id_with_http_info variant

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

<Array(, Integer, Hash)> put_project_projects_by_id_with_http_info(id, client_id, project)

begin
  # Put ApiProject
  data, status_code, headers = api_instance.put_project_projects_by_id_with_http_info(id, client_id, project)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Project>
rescue ConnectWise::ApiError => e
  puts "Error when calling ProjectsApi->put_project_projects_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer projectId
client_id String
project Project project

Return type

Project

Authorization

No authorization required

HTTP request headers

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