cmv4-openapi-client 1.0.3

data/docs/GeneralClassificationsApi.md

@@ -0,0 +1,545 @@
+# CMV4APIClient::GeneralClassificationsApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**classifications_controller_read_get**](GeneralClassificationsApi.md#classifications_controller_read_get) | **GET** /classifications | Get All Classifications
+[**classifications_controller_read_get_children**](GeneralClassificationsApi.md#classifications_controller_read_get_children) | **POST** /classifications/{classificationId}/children | Get children within Projects
+[**classifications_controller_read_get_children_by_path_name**](GeneralClassificationsApi.md#classifications_controller_read_get_children_by_path_name) | **GET** /classifications/byname/{hierarchyPathName} | Get Children By Path
+[**classifications_controller_read_get_classification_by_id**](GeneralClassificationsApi.md#classifications_controller_read_get_classification_by_id) | **GET** /classifications/{classificationId} | Get Classification By Id
+[**classifications_controller_read_get_flat_classification_tree**](GeneralClassificationsApi.md#classifications_controller_read_get_flat_classification_tree) | **POST** /classifications/{classificationId}/flat | Get flat classifications within Projects
+[**classifications_controller_write_create**](GeneralClassificationsApi.md#classifications_controller_write_create) | **POST** /classifications | Create Classification
+[**classifications_controller_write_delete**](GeneralClassificationsApi.md#classifications_controller_write_delete) | **DELETE** /classifications/{id} | Delete a Classification
+[**classifications_controller_write_delete_using_post**](GeneralClassificationsApi.md#classifications_controller_write_delete_using_post) | **POST** /classifications/{id}/delete | Delete a Classification
+[**classifications_controller_write_modify**](GeneralClassificationsApi.md#classifications_controller_write_modify) | **PATCH** /classifications/{id} | Modify Classification
+[**classifications_controller_write_reassign**](GeneralClassificationsApi.md#classifications_controller_write_reassign) | **POST** /classifications/{id}/reassign | Reassign a Classification
+[**classifications_controller_write_restore**](GeneralClassificationsApi.md#classifications_controller_write_restore) | **POST** /classifications/{id}/restore | Restore a Classification
+
+
+
+## classifications_controller_read_get
+
+> Array<Classification> classifications_controller_read_get
+
+Get All Classifications
+
+Gets all of the classifications within the system
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralClassificationsApi.new
+
+begin
+  #Get All Classifications
+  result = api_instance.classifications_controller_read_get
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralClassificationsApi->classifications_controller_read_get: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Classification>**](Classification.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## classifications_controller_read_get_children
+
+> Array<ClassificationViewModel> classifications_controller_read_get_children(classification_id, request_body, opts)
+
+Get children within Projects
+
+Gets child classifications based on the passed id and the posted list of project ids
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralClassificationsApi.new
+classification_id = 56 # Integer | 
+request_body = [56] # Array<Integer> | 
+opts = {
+  deleted: false # Boolean | 
+}
+
+begin
+  #Get children within Projects
+  result = api_instance.classifications_controller_read_get_children(classification_id, request_body, opts)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralClassificationsApi->classifications_controller_read_get_children: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **classification_id** | **Integer**|  | 
+ **request_body** | [**Array&lt;Integer&gt;**](Integer.md)|  | 
+ **deleted** | **Boolean**|  | [optional] [default to false]
+
+### Return type
+
+[**Array&lt;ClassificationViewModel&gt;**](ClassificationViewModel.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## classifications_controller_read_get_children_by_path_name
+
+> Array&lt;Classification&gt; classifications_controller_read_get_children_by_path_name(hierarchy_path_name)
+
+Get Children By Path
+
+Gets all of the child classifications from a specific path
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralClassificationsApi.new
+hierarchy_path_name = 'hierarchy_path_name_example' # String | 
+
+begin
+  #Get Children By Path
+  result = api_instance.classifications_controller_read_get_children_by_path_name(hierarchy_path_name)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralClassificationsApi->classifications_controller_read_get_children_by_path_name: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **hierarchy_path_name** | **String**|  | 
+
+### Return type
+
+[**Array&lt;Classification&gt;**](Classification.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## classifications_controller_read_get_classification_by_id
+
+> Classification classifications_controller_read_get_classification_by_id(classification_id)
+
+Get Classification By Id
+
+Gets a specific classification
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralClassificationsApi.new
+classification_id = 56 # Integer | 
+
+begin
+  #Get Classification By Id
+  result = api_instance.classifications_controller_read_get_classification_by_id(classification_id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralClassificationsApi->classifications_controller_read_get_classification_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **classification_id** | **Integer**|  | 
+
+### Return type
+
+[**Classification**](Classification.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## classifications_controller_read_get_flat_classification_tree
+
+> Array&lt;ClassificationViewModel&gt; classifications_controller_read_get_flat_classification_tree(classification_id, request_body, opts)
+
+Get flat classifications within Projects
+
+Gets a flattened view of the classifications under a particular id within a list of project ids
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralClassificationsApi.new
+classification_id = 56 # Integer | 
+request_body = [56] # Array<Integer> | 
+opts = {
+  deleted: false # Boolean | 
+}
+
+begin
+  #Get flat classifications within Projects
+  result = api_instance.classifications_controller_read_get_flat_classification_tree(classification_id, request_body, opts)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralClassificationsApi->classifications_controller_read_get_flat_classification_tree: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **classification_id** | **Integer**|  | 
+ **request_body** | [**Array&lt;Integer&gt;**](Integer.md)|  | 
+ **deleted** | **Boolean**|  | [optional] [default to false]
+
+### Return type
+
+[**Array&lt;ClassificationViewModel&gt;**](ClassificationViewModel.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## classifications_controller_write_create
+
+> Classification classifications_controller_write_create(ensure_classification_command_data)
+
+Create Classification
+
+Creates a new Classification.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralClassificationsApi.new
+ensure_classification_command_data = CMV4APIClient::EnsureClassificationCommandData.new # EnsureClassificationCommandData | 
+
+begin
+  #Create Classification
+  result = api_instance.classifications_controller_write_create(ensure_classification_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralClassificationsApi->classifications_controller_write_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ensure_classification_command_data** | [**EnsureClassificationCommandData**](EnsureClassificationCommandData.md)|  | 
+
+### Return type
+
+[**Classification**](Classification.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## classifications_controller_write_delete
+
+> classifications_controller_write_delete(id)
+
+Delete a Classification
+
+Deletes an existing Classification.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralClassificationsApi.new
+id = 56 # Integer | 
+
+begin
+  #Delete a Classification
+  api_instance.classifications_controller_write_delete(id)
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralClassificationsApi->classifications_controller_write_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## classifications_controller_write_delete_using_post
+
+> classifications_controller_write_delete_using_post(id)
+
+Delete a Classification
+
+Deletes an existing Classification.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralClassificationsApi.new
+id = 56 # Integer | 
+
+begin
+  #Delete a Classification
+  api_instance.classifications_controller_write_delete_using_post(id)
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralClassificationsApi->classifications_controller_write_delete_using_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## classifications_controller_write_modify
+
+> Classification classifications_controller_write_modify(id, ensure_classification_command_data)
+
+Modify Classification
+
+Modifies an existing Classification.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralClassificationsApi.new
+id = 56 # Integer | 
+ensure_classification_command_data = CMV4APIClient::EnsureClassificationCommandData.new # EnsureClassificationCommandData | 
+
+begin
+  #Modify Classification
+  result = api_instance.classifications_controller_write_modify(id, ensure_classification_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralClassificationsApi->classifications_controller_write_modify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+ **ensure_classification_command_data** | [**EnsureClassificationCommandData**](EnsureClassificationCommandData.md)|  | 
+
+### Return type
+
+[**Classification**](Classification.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## classifications_controller_write_reassign
+
+> Classification classifications_controller_write_reassign(id, reassign_classification_command_data)
+
+Reassign a Classification
+
+Reassigns a Classification.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralClassificationsApi.new
+id = 56 # Integer | 
+reassign_classification_command_data = CMV4APIClient::ReassignClassificationCommandData.new # ReassignClassificationCommandData | 
+
+begin
+  #Reassign a Classification
+  result = api_instance.classifications_controller_write_reassign(id, reassign_classification_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralClassificationsApi->classifications_controller_write_reassign: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+ **reassign_classification_command_data** | [**ReassignClassificationCommandData**](ReassignClassificationCommandData.md)|  | 
+
+### Return type
+
+[**Classification**](Classification.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## classifications_controller_write_restore
+
+> classifications_controller_write_restore(id)
+
+Restore a Classification
+
+Restores a Classification.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+
+api_instance = CMV4APIClient::GeneralClassificationsApi.new
+id = 56 # Integer | 
+
+begin
+  #Restore a Classification
+  api_instance.classifications_controller_write_restore(id)
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling GeneralClassificationsApi->classifications_controller_write_restore: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+