Skip to content

Latest commit

 

History

History
392 lines (255 loc) · 7.95 KB

ProjectsApi.md

File metadata and controls

392 lines (255 loc) · 7.95 KB
Raw

Connectwise::ProjectsApi

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

Method HTTP request Description
project_projects_count_get GET /project/projects/count
project_projects_get GET /project/projects
project_projects_id_delete DELETE /project/projects/{id}
project_projects_id_get GET /project/projects/{id}
project_projects_id_patch PATCH /project/projects/{id}
project_projects_id_put PUT /project/projects/{id}
project_projects_post POST /project/projects

project_projects_count_get

Count project_projects_count_get(opts)

Get Projects 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::ProjectsApi.new

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

begin
  result = api_instance.project_projects_count_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProjectsApi->project_projects_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

project_projects_get

Array<Project> project_projects_get(opts)

Get Projects

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

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

begin
  result = api_instance.project_projects_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProjectsApi->project_projects_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<Project>

Authorization

BasicAuth

HTTP request headers

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

project_projects_id_delete

project_projects_id_delete(id)

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

id = 56 # Integer | 


begin
  api_instance.project_projects_id_delete(id)
rescue Connectwise::ApiError => e
  puts "Exception when calling ProjectsApi->project_projects_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

project_projects_id_get

Project project_projects_id_get(id)

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

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

Project

Authorization

BasicAuth

HTTP request headers

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

project_projects_id_patch

Project project_projects_id_patch(id, operations)

Update Project

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

id = 56 # Integer | 

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


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

Parameters

Name Type Description Notes
id Integer
operations Array<PatchOperation>

Return type

Project

Authorization

BasicAuth

HTTP request headers

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

project_projects_id_put

Project project_projects_id_put(id, project)

Replace Project

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

id = 56 # Integer | 

project = Connectwise::Project.new # Project | 


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

Parameters

Name Type Description Notes
id Integer
project Project

Return type

Project

Authorization

BasicAuth

HTTP request headers

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

project_projects_post

Project project_projects_post(project)

Create Project

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

project = Connectwise::Project.new # Project | 


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

Parameters

Name Type Description Notes
project Project

Return type

Project

Authorization

BasicAuth

HTTP request headers

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