emass_client 1.0.1 → 1.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (149) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +152 -1124
  3. data/Rakefile +2 -0
  4. data/lib/emass_client/api/artifacts_api.rb +124 -97
  5. data/lib/emass_client/api/artifacts_export_api.rb +28 -19
  6. data/lib/emass_client/api/cac_api.rb +50 -31
  7. data/lib/emass_client/api/cloud_resources_api.rb +96 -0
  8. data/lib/emass_client/api/cmmc_assessments_api.rb +20 -11
  9. data/lib/emass_client/api/containers_api.rb +96 -0
  10. data/lib/emass_client/api/controls_api.rb +53 -34
  11. data/lib/emass_client/api/milestones_api.rb +138 -92
  12. data/lib/emass_client/api/pac_api.rb +50 -31
  13. data/lib/emass_client/api/poam_api.rb +132 -86
  14. data/lib/emass_client/api/registration_api.rb +30 -18
  15. data/lib/emass_client/api/static_code_scans_api.rb +38 -26
  16. data/lib/emass_client/api/system_roles_api.rb +48 -29
  17. data/lib/emass_client/api/systems_api.rb +57 -39
  18. data/lib/emass_client/api/test_api.rb +20 -11
  19. data/lib/emass_client/api/test_results_api.rb +53 -34
  20. data/lib/emass_client/api/workflow_definitions_api.rb +23 -14
  21. data/lib/emass_client/api/workflow_instances_api.rb +58 -53
  22. data/lib/emass_client/api_client.rb +59 -57
  23. data/lib/emass_client/api_error.rb +5 -5
  24. data/lib/emass_client/configuration.rb +93 -16
  25. data/lib/emass_client/models/artifacts_get.rb +54 -31
  26. data/lib/emass_client/models/{artifacts_delete_inner.rb → artifacts_request_delete_body_inner.rb} +29 -16
  27. data/lib/emass_client/models/artifacts_response_del.rb +27 -14
  28. data/lib/emass_client/models/{artifacts_response_del_data.rb → artifacts_response_del_data_inner.rb} +31 -18
  29. data/lib/emass_client/models/artifacts_response_get.rb +27 -14
  30. data/lib/emass_client/models/artifacts_response_put_post.rb +27 -14
  31. data/lib/emass_client/models/artifacts_response_put_post_data_inner.rb +265 -0
  32. data/lib/emass_client/models/cac_get.rb +82 -50
  33. data/lib/emass_client/models/cac_response_get.rb +27 -14
  34. data/lib/emass_client/models/cac_response_post.rb +27 -14
  35. data/lib/emass_client/models/{cac_response_post_data.rb → cac_response_post_data_inner.rb} +61 -21
  36. data/lib/emass_client/models/{pac_request_post_body.rb → cloud_resources_post.rb} +73 -69
  37. data/lib/emass_client/models/cloud_resources_response_post.rb +230 -0
  38. data/lib/emass_client/models/cmmc_get.rb +53 -63
  39. data/lib/emass_client/models/cmmc_response_get.rb +27 -14
  40. data/lib/emass_client/models/connectivity_ccsd.rb +29 -14
  41. data/lib/emass_client/models/containers_resources_post.rb +265 -0
  42. data/lib/emass_client/models/containers_response_post.rb +230 -0
  43. data/lib/emass_client/models/controls_get.rb +103 -66
  44. data/lib/emass_client/models/controls_put.rb +58 -18
  45. data/lib/emass_client/models/controls_response_get.rb +28 -14
  46. data/lib/emass_client/models/controls_response_put.rb +27 -14
  47. data/lib/emass_client/models/definition_transitions.rb +32 -62
  48. data/lib/emass_client/models/instances_transitions.rb +37 -88
  49. data/lib/emass_client/models/milestone_response_get.rb +27 -14
  50. data/lib/emass_client/models/milestone_response_get_milestone.rb +228 -0
  51. data/lib/emass_client/models/milestone_response_post.rb +27 -14
  52. data/lib/emass_client/models/milestone_response_put.rb +27 -14
  53. data/lib/emass_client/models/milestones_get.rb +33 -20
  54. data/lib/emass_client/models/milestones_put_post_delete.rb +60 -20
  55. data/lib/emass_client/models/{delete_milestone.rb → milestones_request_delete_body_inner.rb} +29 -21
  56. data/lib/emass_client/models/milestones_required_post.rb +27 -14
  57. data/lib/emass_client/models/milestones_required_put.rb +28 -15
  58. data/lib/emass_client/models/pac_get.rb +39 -22
  59. data/lib/emass_client/models/pac_post.rb +60 -20
  60. data/lib/emass_client/models/pac_response_get.rb +28 -14
  61. data/lib/emass_client/models/pac_response_post.rb +27 -14
  62. data/lib/emass_client/models/poam_get.rb +114 -77
  63. data/lib/emass_client/models/poam_post_put_del.rb +59 -19
  64. data/lib/emass_client/models/{delete_poam.rb → poam_request_delete_body_inner.rb} +29 -21
  65. data/lib/emass_client/models/poam_response_delete.rb +27 -14
  66. data/lib/emass_client/models/poam_response_get_poams.rb +228 -0
  67. data/lib/emass_client/models/{static_code_required_post.rb → poam_response_get_systems.rb} +42 -29
  68. data/lib/emass_client/models/poam_response_post.rb +27 -14
  69. data/lib/emass_client/models/poam_response_put.rb +27 -14
  70. data/lib/emass_client/models/register.rb +27 -14
  71. data/lib/emass_client/models/register_data.rb +26 -13
  72. data/lib/emass_client/models/register_user_request_post_body.rb +26 -13
  73. data/lib/emass_client/models/{model_200.rb → response200.rb} +53 -16
  74. data/lib/emass_client/models/{model_400.rb → response201.rb} +29 -16
  75. data/lib/emass_client/models/{model_201_meta.rb → response201_meta.rb} +54 -17
  76. data/lib/emass_client/models/{model_400_response.rb → response400.rb} +29 -16
  77. data/lib/emass_client/models/{model_400_meta.rb → response400_meta.rb} +54 -17
  78. data/lib/emass_client/models/{model_401.rb → response401.rb} +29 -16
  79. data/lib/emass_client/models/{model_401_meta.rb → response401_meta.rb} +54 -17
  80. data/lib/emass_client/models/{model_201.rb → response403.rb} +29 -16
  81. data/lib/emass_client/models/{model_403_meta.rb → response403_meta.rb} +54 -17
  82. data/lib/emass_client/models/{model_404.rb → response404.rb} +54 -17
  83. data/lib/emass_client/models/response405.rb +219 -0
  84. data/lib/emass_client/models/{model_405_meta.rb → response405_meta.rb} +54 -17
  85. data/lib/emass_client/models/response411.rb +219 -0
  86. data/lib/emass_client/models/{model_411_meta.rb → response411_meta.rb} +54 -17
  87. data/lib/emass_client/models/response490.rb +219 -0
  88. data/lib/emass_client/models/{model_490_meta.rb → response490_meta.rb} +54 -17
  89. data/lib/emass_client/models/response500.rb +219 -0
  90. data/lib/emass_client/models/{model_500_meta.rb → response500_meta.rb} +54 -17
  91. data/lib/emass_client/models/role_category.rb +32 -50
  92. data/lib/emass_client/models/roles.rb +29 -61
  93. data/lib/emass_client/models/ssps.rb +32 -16
  94. data/lib/emass_client/models/stage.rb +30 -49
  95. data/lib/emass_client/models/static_code_application.rb +34 -33
  96. data/lib/emass_client/models/static_code_post.rb +275 -0
  97. data/lib/emass_client/models/static_code_request_post_body.rb +47 -14
  98. data/lib/emass_client/models/{static_code_required_post_application.rb → static_code_request_post_body_application.rb} +30 -17
  99. data/lib/emass_client/models/static_code_response_post.rb +230 -0
  100. data/lib/emass_client/models/success200_response.rb +27 -14
  101. data/lib/emass_client/models/{error.rb → success200_response_data_inner.rb} +57 -36
  102. data/lib/emass_client/models/system_response.rb +28 -17
  103. data/lib/emass_client/models/system_roles_category_response.rb +28 -14
  104. data/lib/emass_client/models/system_roles_response.rb +27 -14
  105. data/lib/emass_client/models/{system_roles_response_data.rb → system_roles_response_data_inner.rb} +30 -17
  106. data/lib/emass_client/models/systems.rb +218 -191
  107. data/lib/emass_client/models/{poam_response_get.rb → systems_response.rb} +30 -17
  108. data/lib/emass_client/models/test.rb +27 -14
  109. data/lib/emass_client/models/test_data.rb +26 -13
  110. data/lib/emass_client/models/test_results_get.rb +39 -35
  111. data/lib/emass_client/models/test_results_post.rb +58 -18
  112. data/lib/emass_client/models/test_results_response_get.rb +27 -14
  113. data/lib/emass_client/models/test_results_response_post.rb +27 -14
  114. data/lib/emass_client/models/users.rb +28 -15
  115. data/lib/emass_client/models/workflow_definition_get.rb +63 -68
  116. data/lib/emass_client/models/workflow_definition_response_get.rb +27 -14
  117. data/lib/emass_client/models/workflow_instance_get.rb +331 -0
  118. data/lib/emass_client/models/workflow_instance_response_get.rb +230 -0
  119. data/lib/emass_client/models/workflow_instances_get.rb +107 -133
  120. data/lib/emass_client/models/workflow_instances_response_get.rb +39 -17
  121. data/lib/emass_client/models/workflow_instances_response_get_pagination.rb +246 -0
  122. data/lib/emass_client/version.rb +6 -5
  123. data/lib/emass_client.rb +47 -54
  124. metadata +60 -89
  125. data/lib/emass_client/models/artifacts_delete.rb +0 -201
  126. data/lib/emass_client/models/artifacts_request_put_body.rb +0 -363
  127. data/lib/emass_client/models/cac_request_post_body.rb +0 -217
  128. data/lib/emass_client/models/controls_request_put_body.rb +0 -606
  129. data/lib/emass_client/models/empty200_response.rb +0 -197
  130. data/lib/emass_client/models/milestones_delete.rb +0 -197
  131. data/lib/emass_client/models/milestones_post.rb +0 -197
  132. data/lib/emass_client/models/milestones_put.rb +0 -197
  133. data/lib/emass_client/models/milestones_request_post_body.rb +0 -242
  134. data/lib/emass_client/models/milestones_request_put_body.rb +0 -242
  135. data/lib/emass_client/models/model_403.rb +0 -206
  136. data/lib/emass_client/models/model_404_response.rb +0 -206
  137. data/lib/emass_client/models/model_405.rb +0 -206
  138. data/lib/emass_client/models/model_411.rb +0 -206
  139. data/lib/emass_client/models/model_490.rb +0 -206
  140. data/lib/emass_client/models/model_500.rb +0 -206
  141. data/lib/emass_client/models/poam_delete.rb +0 -197
  142. data/lib/emass_client/models/poam_post.rb +0 -197
  143. data/lib/emass_client/models/poam_put.rb +0 -197
  144. data/lib/emass_client/models/poam_request_post_body.rb +0 -197
  145. data/lib/emass_client/models/poam_request_put_body.rb +0 -197
  146. data/lib/emass_client/models/poam_required_post.rb +0 -564
  147. data/lib/emass_client/models/poam_required_put.rb +0 -594
  148. data/lib/emass_client/models/system_id_artifacts_body.rb +0 -284
  149. data/lib/emass_client/models/test_results_request_post_body.rb +0 -306
@@ -1,14 +1,17 @@
1
1
  =begin
2
2
  #Enterprise Mission Assurance Support Service (eMASS)
3
3
 
4
- #The Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records. The `emasser` is a command-line interface (CLI) tool that implements all of the eMASS endpoints defined in the eMASS REST API v3.2, dated October 21, 2021.</br><br> <strong>Register CLI</strong></br> New users will need to register an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API requires a client certificate (SSL/TLS, DoD PKI only) where {url}/api/register (POST) is used to register the client certificate.</br></br> Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key. The API key must be provided in the request header for all endpoint calls (api-key). If the service receives an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br> <strong>Available Request Headers:</strong></br> <table> <tr> <th align=left>key</th> <th align=left>Example Value</th> <th align=left>Description</th> </tr> <tr> <td>`api-key`</td> <td>api-key-provided-by-emass</td> <td>This API key must be provided in the request header for all endpoint calls</td> </tr> <tr> <td>`user-uid`</td> <td>USER.UID.KEY</td> <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td> </tr> <tr> <td></td><td></td> <td> Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC </td> </tr> </table> </br><strong>Approve API Client for Actionable Requests</strong></br> Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions. Please note that leaving a field parameter blank (for PUT/POST requests) has the potential to clear information in the active eMASS records. To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC:
4
+ #The Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API requires a client certificate (SSL/TLS, DoD PKI only). Use the `Registration` endpoint to register the client certificate.</br></br> Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key. The API key must be provided in the request header for all endpoint calls (api-key). If the service receives an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br> <strong>Available Request Headers</strong></br> <table> <tr> <th align=left>key</th> <th align=left>Example Value</th> <th align=left>Description</th> </tr> <tr> <td>`api-key`</td> <td>api-key-provided-by-emass</td> <td>This API key must be provided in the request header for all endpoint calls</td> </tr> <tr> <td>`user-uid`</td> <td>USER.UID.KEY</td> <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td> </tr> <tr> <td></td><td></td> <td> Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC </td> </tr> </table> </br><strong>Approve API Client for Actionable Requests</strong></br> Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions. Please note that leaving a field parameter blank (for PUT/POST requests) has the potential to clear information in the active eMASS records. To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC:
5
5
 
6
- OpenAPI spec version: v3.2
6
+ The version of the OpenAPI document: v3.3
7
7
  Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.26
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1-SNAPSHOT
10
+
10
11
  =end
11
12
 
13
+ require 'cgi'
14
+
12
15
  module EmassClient
13
16
  class TestApi
14
17
  attr_accessor :api_client
@@ -17,7 +20,7 @@ module EmassClient
17
20
  @api_client = api_client
18
21
  end
19
22
  # Test connection to the API
20
- # Returns endpoint call status
23
+ # Tests the endpoint connection
21
24
  # @param [Hash] opts the optional parameters
22
25
  # @return [Test]
23
26
  def test_connection(opts = {})
@@ -26,7 +29,7 @@ module EmassClient
26
29
  end
27
30
 
28
31
  # Test connection to the API
29
- # Returns endpoint call status
32
+ # Tests the endpoint connection
30
33
  # @param [Hash] opts the optional parameters
31
34
  # @return [Array<(Test, Integer, Hash)>] Test data, response status code and response headers
32
35
  def test_connection_with_http_info(opts = {})
@@ -48,19 +51,25 @@ module EmassClient
48
51
  form_params = opts[:form_params] || {}
49
52
 
50
53
  # http body (model)
51
- post_body = opts[:body]
54
+ post_body = opts[:debug_body]
55
+
56
+ # return_type
57
+ return_type = opts[:debug_return_type] || 'Test'
52
58
 
53
- return_type = opts[:return_type] || 'Test'
59
+ # auth_names
60
+ auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
54
61
 
55
- auth_names = opts[:auth_names] || ['apikey', 'mockType', 'userid']
56
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
62
+ new_options = opts.merge(
63
+ :operation => :"TestApi.test_connection",
57
64
  :header_params => header_params,
58
65
  :query_params => query_params,
59
66
  :form_params => form_params,
60
67
  :body => post_body,
61
68
  :auth_names => auth_names,
62
- :return_type => return_type)
69
+ :return_type => return_type
70
+ )
63
71
 
72
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
64
73
  if @api_client.config.debugging
65
74
  @api_client.config.logger.debug "API called: TestApi#test_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
66
75
  end
@@ -1,14 +1,17 @@
1
1
  =begin
2
2
  #Enterprise Mission Assurance Support Service (eMASS)
3
3
 
4
- #The Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records. The `emasser` is a command-line interface (CLI) tool that implements all of the eMASS endpoints defined in the eMASS REST API v3.2, dated October 21, 2021.</br><br> <strong>Register CLI</strong></br> New users will need to register an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API requires a client certificate (SSL/TLS, DoD PKI only) where {url}/api/register (POST) is used to register the client certificate.</br></br> Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key. The API key must be provided in the request header for all endpoint calls (api-key). If the service receives an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br> <strong>Available Request Headers:</strong></br> <table> <tr> <th align=left>key</th> <th align=left>Example Value</th> <th align=left>Description</th> </tr> <tr> <td>`api-key`</td> <td>api-key-provided-by-emass</td> <td>This API key must be provided in the request header for all endpoint calls</td> </tr> <tr> <td>`user-uid`</td> <td>USER.UID.KEY</td> <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td> </tr> <tr> <td></td><td></td> <td> Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC </td> </tr> </table> </br><strong>Approve API Client for Actionable Requests</strong></br> Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions. Please note that leaving a field parameter blank (for PUT/POST requests) has the potential to clear information in the active eMASS records. To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC:
4
+ #The Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API requires a client certificate (SSL/TLS, DoD PKI only). Use the `Registration` endpoint to register the client certificate.</br></br> Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key. The API key must be provided in the request header for all endpoint calls (api-key). If the service receives an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br> <strong>Available Request Headers</strong></br> <table> <tr> <th align=left>key</th> <th align=left>Example Value</th> <th align=left>Description</th> </tr> <tr> <td>`api-key`</td> <td>api-key-provided-by-emass</td> <td>This API key must be provided in the request header for all endpoint calls</td> </tr> <tr> <td>`user-uid`</td> <td>USER.UID.KEY</td> <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td> </tr> <tr> <td></td><td></td> <td> Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC </td> </tr> </table> </br><strong>Approve API Client for Actionable Requests</strong></br> Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions. Please note that leaving a field parameter blank (for PUT/POST requests) has the potential to clear information in the active eMASS records. To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC:
5
5
 
6
- OpenAPI spec version: v3.2
6
+ The version of the OpenAPI document: v3.3
7
7
  Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.26
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1-SNAPSHOT
10
+
10
11
  =end
11
12
 
13
+ require 'cgi'
14
+
12
15
  module EmassClient
13
16
  class TestResultsApi
14
17
  attr_accessor :api_client
@@ -18,35 +21,35 @@ module EmassClient
18
21
  end
19
22
  # Add one or many test results in a system
20
23
  # Adds test results for given `systemId` **Request Body Required Fields** - `cci` - `testedBy` - `testDate` - `description` - `complianceStatus`
21
- # @param body Update an existing control by Id
22
- # @param system_id **System Id**: The unique system record identifier.
24
+ # @param system_id [Integer] **System Id**: The unique system record identifier.
25
+ # @param request_body [Array<Object>] Add test results to a system (systemId)
23
26
  # @param [Hash] opts the optional parameters
24
27
  # @return [TestResultsResponsePost]
25
- def add_test_results_by_system_id(body, system_id, opts = {})
26
- data, _status_code, _headers = add_test_results_by_system_id_with_http_info(body, system_id, opts)
28
+ def add_test_results_by_system_id(system_id, request_body, opts = {})
29
+ data, _status_code, _headers = add_test_results_by_system_id_with_http_info(system_id, request_body, opts)
27
30
  data
28
31
  end
29
32
 
30
33
  # Add one or many test results in a system
31
34
  # Adds test results for given &#x60;systemId&#x60; **Request Body Required Fields** - &#x60;cci&#x60; - &#x60;testedBy&#x60; - &#x60;testDate&#x60; - &#x60;description&#x60; - &#x60;complianceStatus&#x60;
32
- # @param body Update an existing control by Id
33
- # @param system_id **System Id**: The unique system record identifier.
35
+ # @param system_id [Integer] **System Id**: The unique system record identifier.
36
+ # @param request_body [Array<Object>] Add test results to a system (systemId)
34
37
  # @param [Hash] opts the optional parameters
35
38
  # @return [Array<(TestResultsResponsePost, Integer, Hash)>] TestResultsResponsePost data, response status code and response headers
36
- def add_test_results_by_system_id_with_http_info(body, system_id, opts = {})
39
+ def add_test_results_by_system_id_with_http_info(system_id, request_body, opts = {})
37
40
  if @api_client.config.debugging
38
41
  @api_client.config.logger.debug 'Calling API: TestResultsApi.add_test_results_by_system_id ...'
39
42
  end
40
- # verify the required parameter 'body' is set
41
- if @api_client.config.client_side_validation && body.nil?
42
- fail ArgumentError, "Missing the required parameter 'body' when calling TestResultsApi.add_test_results_by_system_id"
43
- end
44
43
  # verify the required parameter 'system_id' is set
45
44
  if @api_client.config.client_side_validation && system_id.nil?
46
45
  fail ArgumentError, "Missing the required parameter 'system_id' when calling TestResultsApi.add_test_results_by_system_id"
47
46
  end
47
+ # verify the required parameter 'request_body' is set
48
+ if @api_client.config.client_side_validation && request_body.nil?
49
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling TestResultsApi.add_test_results_by_system_id"
50
+ end
48
51
  # resource path
49
- local_var_path = '/api/systems/{systemId}/test-results'.sub('{' + 'systemId' + '}', system_id.to_s)
52
+ local_var_path = '/api/systems/{systemId}/test-results'.sub('{' + 'systemId' + '}', CGI.escape(system_id.to_s))
50
53
 
51
54
  # query parameters
52
55
  query_params = opts[:query_params] || {}
@@ -56,37 +59,47 @@ module EmassClient
56
59
  # HTTP header 'Accept' (if needed)
57
60
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
58
61
  # HTTP header 'Content-Type'
59
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
62
+ content_type = @api_client.select_header_content_type(['application/json'])
63
+ if !content_type.nil?
64
+ header_params['Content-Type'] = content_type
65
+ end
60
66
 
61
67
  # form parameters
62
68
  form_params = opts[:form_params] || {}
63
69
 
64
70
  # http body (model)
65
- post_body = opts[:body] || @api_client.object_to_http_body(body)
71
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
72
+
73
+ # return_type
74
+ return_type = opts[:debug_return_type] || 'TestResultsResponsePost'
66
75
 
67
- return_type = opts[:return_type] || 'TestResultsResponsePost'
76
+ # auth_names
77
+ auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
68
78
 
69
- auth_names = opts[:auth_names] || ['apikey', 'mockType', 'userid']
70
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
79
+ new_options = opts.merge(
80
+ :operation => :"TestResultsApi.add_test_results_by_system_id",
71
81
  :header_params => header_params,
72
82
  :query_params => query_params,
73
83
  :form_params => form_params,
74
84
  :body => post_body,
75
85
  :auth_names => auth_names,
76
- :return_type => return_type)
86
+ :return_type => return_type
87
+ )
77
88
 
89
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
78
90
  if @api_client.config.debugging
79
91
  @api_client.config.logger.debug "API called: TestResultsApi#add_test_results_by_system_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
80
92
  end
81
93
  return data, status_code, headers
82
94
  end
95
+
83
96
  # Get one or many test results in a system
84
97
  # Returns system test results information for matching parameters.<br>
85
- # @param system_id **System Id**: The unique system record identifier.
98
+ # @param system_id [Integer] **System Id**: The unique system record identifier.
86
99
  # @param [Hash] opts the optional parameters
87
100
  # @option opts [String] :control_acronyms **System Acronym**: Filter query by given system acronym (single or comma separated).
88
- # @option opts [String] :ccis **CCI System**: Filter query by Control Correlation Identifiers (CCIs).
89
- # @option opts [BOOLEAN] :latest_only **Latest Results Only**: Indicates that only the latest test resultes are retrieved (single or comma separated). (default to true)
101
+ # @option opts [String] :ccis **CCI System**: Filter query by Control Correlation Identifiers (CCIs) (single or comma separated).
102
+ # @option opts [Boolean] :latest_only **Latest Results Only**: Indicates that only the latest test resultes are retrieved (single or comma separated). (default to true)
90
103
  # @return [TestResultsResponseGet]
91
104
  def get_system_test_results(system_id, opts = {})
92
105
  data, _status_code, _headers = get_system_test_results_with_http_info(system_id, opts)
@@ -95,11 +108,11 @@ module EmassClient
95
108
 
96
109
  # Get one or many test results in a system
97
110
  # Returns system test results information for matching parameters.&lt;br&gt;
98
- # @param system_id **System Id**: The unique system record identifier.
111
+ # @param system_id [Integer] **System Id**: The unique system record identifier.
99
112
  # @param [Hash] opts the optional parameters
100
113
  # @option opts [String] :control_acronyms **System Acronym**: Filter query by given system acronym (single or comma separated).
101
- # @option opts [String] :ccis **CCI System**: Filter query by Control Correlation Identifiers (CCIs).
102
- # @option opts [BOOLEAN] :latest_only **Latest Results Only**: Indicates that only the latest test resultes are retrieved (single or comma separated).
114
+ # @option opts [String] :ccis **CCI System**: Filter query by Control Correlation Identifiers (CCIs) (single or comma separated).
115
+ # @option opts [Boolean] :latest_only **Latest Results Only**: Indicates that only the latest test resultes are retrieved (single or comma separated). (default to true)
103
116
  # @return [Array<(TestResultsResponseGet, Integer, Hash)>] TestResultsResponseGet data, response status code and response headers
104
117
  def get_system_test_results_with_http_info(system_id, opts = {})
105
118
  if @api_client.config.debugging
@@ -110,7 +123,7 @@ module EmassClient
110
123
  fail ArgumentError, "Missing the required parameter 'system_id' when calling TestResultsApi.get_system_test_results"
111
124
  end
112
125
  # resource path
113
- local_var_path = '/api/systems/{systemId}/test-results'.sub('{' + 'systemId' + '}', system_id.to_s)
126
+ local_var_path = '/api/systems/{systemId}/test-results'.sub('{' + 'systemId' + '}', CGI.escape(system_id.to_s))
114
127
 
115
128
  # query parameters
116
129
  query_params = opts[:query_params] || {}
@@ -127,19 +140,25 @@ module EmassClient
127
140
  form_params = opts[:form_params] || {}
128
141
 
129
142
  # http body (model)
130
- post_body = opts[:body]
143
+ post_body = opts[:debug_body]
144
+
145
+ # return_type
146
+ return_type = opts[:debug_return_type] || 'TestResultsResponseGet'
131
147
 
132
- return_type = opts[:return_type] || 'TestResultsResponseGet'
148
+ # auth_names
149
+ auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
133
150
 
134
- auth_names = opts[:auth_names] || ['apikey', 'mockType', 'userid']
135
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
151
+ new_options = opts.merge(
152
+ :operation => :"TestResultsApi.get_system_test_results",
136
153
  :header_params => header_params,
137
154
  :query_params => query_params,
138
155
  :form_params => form_params,
139
156
  :body => post_body,
140
157
  :auth_names => auth_names,
141
- :return_type => return_type)
158
+ :return_type => return_type
159
+ )
142
160
 
161
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
143
162
  if @api_client.config.debugging
144
163
  @api_client.config.logger.debug "API called: TestResultsApi#get_system_test_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
145
164
  end
@@ -1,14 +1,17 @@
1
1
  =begin
2
2
  #Enterprise Mission Assurance Support Service (eMASS)
3
3
 
4
- #The Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records. The `emasser` is a command-line interface (CLI) tool that implements all of the eMASS endpoints defined in the eMASS REST API v3.2, dated October 21, 2021.</br><br> <strong>Register CLI</strong></br> New users will need to register an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API requires a client certificate (SSL/TLS, DoD PKI only) where {url}/api/register (POST) is used to register the client certificate.</br></br> Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key. The API key must be provided in the request header for all endpoint calls (api-key). If the service receives an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br> <strong>Available Request Headers:</strong></br> <table> <tr> <th align=left>key</th> <th align=left>Example Value</th> <th align=left>Description</th> </tr> <tr> <td>`api-key`</td> <td>api-key-provided-by-emass</td> <td>This API key must be provided in the request header for all endpoint calls</td> </tr> <tr> <td>`user-uid`</td> <td>USER.UID.KEY</td> <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td> </tr> <tr> <td></td><td></td> <td> Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC </td> </tr> </table> </br><strong>Approve API Client for Actionable Requests</strong></br> Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions. Please note that leaving a field parameter blank (for PUT/POST requests) has the potential to clear information in the active eMASS records. To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC:
4
+ #The Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API requires a client certificate (SSL/TLS, DoD PKI only). Use the `Registration` endpoint to register the client certificate.</br></br> Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key. The API key must be provided in the request header for all endpoint calls (api-key). If the service receives an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br> <strong>Available Request Headers</strong></br> <table> <tr> <th align=left>key</th> <th align=left>Example Value</th> <th align=left>Description</th> </tr> <tr> <td>`api-key`</td> <td>api-key-provided-by-emass</td> <td>This API key must be provided in the request header for all endpoint calls</td> </tr> <tr> <td>`user-uid`</td> <td>USER.UID.KEY</td> <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td> </tr> <tr> <td></td><td></td> <td> Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC </td> </tr> </table> </br><strong>Approve API Client for Actionable Requests</strong></br> Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions. Please note that leaving a field parameter blank (for PUT/POST requests) has the potential to clear information in the active eMASS records. To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC:
5
5
 
6
- OpenAPI spec version: v3.2
6
+ The version of the OpenAPI document: v3.3
7
7
  Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.26
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1-SNAPSHOT
10
+
10
11
  =end
11
12
 
13
+ require 'cgi'
14
+
12
15
  module EmassClient
13
16
  class WorkflowDefinitionsApi
14
17
  attr_accessor :api_client
@@ -19,8 +22,8 @@ module EmassClient
19
22
  # Get workflow definitions in a site
20
23
  # View all workflow schemas available on the eMASS instance filtered by status `includeInactive` and registration type `registrationType`.
21
24
  # @param [Hash] opts the optional parameters
22
- # @option opts [BOOLEAN] :include_inactive **Include Inactive**: If no value is specified, the default returns false to not include outdated workflow definitions. (default to true)
23
- # @option opts [String] :registration_type **Registration Type**: Filter record by selected registration type (single value or comma delimited values). *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider (default to regular)
25
+ # @option opts [Boolean] :include_inactive **Include Inactive**: If no value is specified, the default returns false to not include outdated workflow definitions. (default to true)
26
+ # @option opts [String] :registration_type **Registration Type**: Filter record by selected registration type (single value or comma delimited values). *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider (default to 'regular')
24
27
  # @return [WorkflowDefinitionResponseGet]
25
28
  def get_workflow_definitions(opts = {})
26
29
  data, _status_code, _headers = get_workflow_definitions_with_http_info(opts)
@@ -30,15 +33,15 @@ module EmassClient
30
33
  # Get workflow definitions in a site
31
34
  # View all workflow schemas available on the eMASS instance filtered by status &#x60;includeInactive&#x60; and registration type &#x60;registrationType&#x60;.
32
35
  # @param [Hash] opts the optional parameters
33
- # @option opts [BOOLEAN] :include_inactive **Include Inactive**: If no value is specified, the default returns false to not include outdated workflow definitions.
34
- # @option opts [String] :registration_type **Registration Type**: Filter record by selected registration type (single value or comma delimited values). *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider
36
+ # @option opts [Boolean] :include_inactive **Include Inactive**: If no value is specified, the default returns false to not include outdated workflow definitions. (default to true)
37
+ # @option opts [String] :registration_type **Registration Type**: Filter record by selected registration type (single value or comma delimited values). *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider (default to 'regular')
35
38
  # @return [Array<(WorkflowDefinitionResponseGet, Integer, Hash)>] WorkflowDefinitionResponseGet data, response status code and response headers
36
39
  def get_workflow_definitions_with_http_info(opts = {})
37
40
  if @api_client.config.debugging
38
41
  @api_client.config.logger.debug 'Calling API: WorkflowDefinitionsApi.get_workflow_definitions ...'
39
42
  end
40
43
  # resource path
41
- local_var_path = '/api/workflow-definitions'
44
+ local_var_path = '/api/workflows/definitions'
42
45
 
43
46
  # query parameters
44
47
  query_params = opts[:query_params] || {}
@@ -54,19 +57,25 @@ module EmassClient
54
57
  form_params = opts[:form_params] || {}
55
58
 
56
59
  # http body (model)
57
- post_body = opts[:body]
60
+ post_body = opts[:debug_body]
61
+
62
+ # return_type
63
+ return_type = opts[:debug_return_type] || 'WorkflowDefinitionResponseGet'
58
64
 
59
- return_type = opts[:return_type] || 'WorkflowDefinitionResponseGet'
65
+ # auth_names
66
+ auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
60
67
 
61
- auth_names = opts[:auth_names] || ['apikey', 'mockType', 'userid']
62
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
68
+ new_options = opts.merge(
69
+ :operation => :"WorkflowDefinitionsApi.get_workflow_definitions",
63
70
  :header_params => header_params,
64
71
  :query_params => query_params,
65
72
  :form_params => form_params,
66
73
  :body => post_body,
67
74
  :auth_names => auth_names,
68
- :return_type => return_type)
75
+ :return_type => return_type
76
+ )
69
77
 
78
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
70
79
  if @api_client.config.debugging
71
80
  @api_client.config.logger.debug "API called: WorkflowDefinitionsApi#get_workflow_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
72
81
  end
@@ -1,14 +1,17 @@
1
1
  =begin
2
2
  #Enterprise Mission Assurance Support Service (eMASS)
3
3
 
4
- #The Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records. The `emasser` is a command-line interface (CLI) tool that implements all of the eMASS endpoints defined in the eMASS REST API v3.2, dated October 21, 2021.</br><br> <strong>Register CLI</strong></br> New users will need to register an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API requires a client certificate (SSL/TLS, DoD PKI only) where {url}/api/register (POST) is used to register the client certificate.</br></br> Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key. The API key must be provided in the request header for all endpoint calls (api-key). If the service receives an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br> <strong>Available Request Headers:</strong></br> <table> <tr> <th align=left>key</th> <th align=left>Example Value</th> <th align=left>Description</th> </tr> <tr> <td>`api-key`</td> <td>api-key-provided-by-emass</td> <td>This API key must be provided in the request header for all endpoint calls</td> </tr> <tr> <td>`user-uid`</td> <td>USER.UID.KEY</td> <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td> </tr> <tr> <td></td><td></td> <td> Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC </td> </tr> </table> </br><strong>Approve API Client for Actionable Requests</strong></br> Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions. Please note that leaving a field parameter blank (for PUT/POST requests) has the potential to clear information in the active eMASS records. To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC:
4
+ #The Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) enables users to perform assessments and complete actions associated with system records. <strong>Register External Application (that use the eMASS API)</strong></br> New users will need to [register](https://nisp.emass.apps.mil/Content/Help/jobaids/eMASS_OT_NewUser_Job_Aid.pdf) an API key with the eMASS development team prior to accessing the site for the first time. The eMASS REST API requires a client certificate (SSL/TLS, DoD PKI only). Use the `Registration` endpoint to register the client certificate.</br></br> Every call to the eMASS REST API will require the use of the agreed upon public key certificate and API key. The API key must be provided in the request header for all endpoint calls (api-key). If the service receives an untrusted certificate or API key, a 401 error response code will be returned along with an error message.</br></br> <strong>Available Request Headers</strong></br> <table> <tr> <th align=left>key</th> <th align=left>Example Value</th> <th align=left>Description</th> </tr> <tr> <td>`api-key`</td> <td>api-key-provided-by-emass</td> <td>This API key must be provided in the request header for all endpoint calls</td> </tr> <tr> <td>`user-uid`</td> <td>USER.UID.KEY</td> <td>This User unique identifier key must be provided in the request header for all PUT, POST, and DELETE endpoint calls</td> </tr> <tr> <td></td><td></td> <td> Note: For DoD users this is the DoD ID Number (EIDIPI) on their DoD CAC </td> </tr> </table> </br><strong>Approve API Client for Actionable Requests</strong></br> Users are required to log-in to eMASS and grant permissions for a client to update data within eMASS on their behalf. This is only required for actionable requests (PUT, POST, DELETE). The Registration Endpoint and all GET requests can be accessed without completing this process with the correct permissions. Please note that leaving a field parameter blank (for PUT/POST requests) has the potential to clear information in the active eMASS records. To establish an account with eMASS and/or acquire an api-key/user-uid, contact one of the listed POC:
5
5
 
6
- OpenAPI spec version: v3.2
6
+ The version of the OpenAPI document: v3.3
7
7
  Contact: disa.meade.id.mbx.emass-tier-iii-support@mail.mil
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.26
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1-SNAPSHOT
10
+
10
11
  =end
11
12
 
13
+ require 'cgi'
14
+
12
15
  module EmassClient
13
16
  class WorkflowInstancesApi
14
17
  attr_accessor :api_client
@@ -16,42 +19,37 @@ module EmassClient
16
19
  def initialize(api_client = ApiClient.default)
17
20
  @api_client = api_client
18
21
  end
19
- # Get workflow instances in a system
20
- # View detailed information on all active and historical workflows for a system `systemId` and filtered by provided parameters.
21
- # @param system_id **System Id**: The unique system record identifier.
22
+ # Get workflow instances in a site
23
+ # View detailed information on all active and historical workflows filtered by provided parameters.
22
24
  # @param [Hash] opts the optional parameters
23
- # @option opts [BOOLEAN] :include_comments **Include Comments**: If no value is specified, the default returns true to not include transition comments. Note: Corresponds to the Comments textbox that is required at most workflow transitions. Does not include other text input fields such as Terms / Conditions for Authorization. (default to true)
25
+ # @option opts [Boolean] :include_comments **Include Comments**: If no value is specified, the default returns true to not include transition comments. Note: Corresponds to the Comments textbox that is required at most workflow transitions. Does not include other text input fields such as Terms / Conditions for Authorization. (default to true)
24
26
  # @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns true to not include transition comments. (default to 0)
25
27
  # @option opts [String] :since_date **Date**: Filter on authorization/assessment date (Unix date format). Note: Filters off the lastEditedDate field. Note: The authorization/assessment decisions on completed workflows can be edited for up to 30 days after the initial decision is made.
26
- # @option opts [String] :status **Status**: Filter by status. If no value is specified, the default returns all to include both active and inactive workflows. Note: Any workflows at a current stage of Complete or Cancelled are inactive. Ongoing workflows currently at other stages are active. (default to all)
28
+ # @option opts [String] :status **Status**: Filter by status. If no value is specified, the default returns all to include both active and inactive workflows. Note: Any workflows at a current stage of Complete or Cancelled are inactive. Ongoing workflows currently at other stages are active. (default to 'all')
27
29
  # @return [WorkflowInstancesResponseGet]
28
- def get_system_workflow_instances(system_id, opts = {})
29
- data, _status_code, _headers = get_system_workflow_instances_with_http_info(system_id, opts)
30
+ def get_system_workflow_instances(opts = {})
31
+ data, _status_code, _headers = get_system_workflow_instances_with_http_info(opts)
30
32
  data
31
33
  end
32
34
 
33
- # Get workflow instances in a system
34
- # View detailed information on all active and historical workflows for a system &#x60;systemId&#x60; and filtered by provided parameters.
35
- # @param system_id **System Id**: The unique system record identifier.
35
+ # Get workflow instances in a site
36
+ # View detailed information on all active and historical workflows filtered by provided parameters.
36
37
  # @param [Hash] opts the optional parameters
37
- # @option opts [BOOLEAN] :include_comments **Include Comments**: If no value is specified, the default returns true to not include transition comments. Note: Corresponds to the Comments textbox that is required at most workflow transitions. Does not include other text input fields such as Terms / Conditions for Authorization.
38
- # @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns true to not include transition comments.
38
+ # @option opts [Boolean] :include_comments **Include Comments**: If no value is specified, the default returns true to not include transition comments. Note: Corresponds to the Comments textbox that is required at most workflow transitions. Does not include other text input fields such as Terms / Conditions for Authorization. (default to true)
39
+ # @option opts [Integer] :page_index **Page Index**: If no value is specified, the default returns true to not include transition comments. (default to 0)
39
40
  # @option opts [String] :since_date **Date**: Filter on authorization/assessment date (Unix date format). Note: Filters off the lastEditedDate field. Note: The authorization/assessment decisions on completed workflows can be edited for up to 30 days after the initial decision is made.
40
- # @option opts [String] :status **Status**: Filter by status. If no value is specified, the default returns all to include both active and inactive workflows. Note: Any workflows at a current stage of Complete or Cancelled are inactive. Ongoing workflows currently at other stages are active.
41
+ # @option opts [String] :status **Status**: Filter by status. If no value is specified, the default returns all to include both active and inactive workflows. Note: Any workflows at a current stage of Complete or Cancelled are inactive. Ongoing workflows currently at other stages are active. (default to 'all')
41
42
  # @return [Array<(WorkflowInstancesResponseGet, Integer, Hash)>] WorkflowInstancesResponseGet data, response status code and response headers
42
- def get_system_workflow_instances_with_http_info(system_id, opts = {})
43
+ def get_system_workflow_instances_with_http_info(opts = {})
43
44
  if @api_client.config.debugging
44
45
  @api_client.config.logger.debug 'Calling API: WorkflowInstancesApi.get_system_workflow_instances ...'
45
46
  end
46
- # verify the required parameter 'system_id' is set
47
- if @api_client.config.client_side_validation && system_id.nil?
48
- fail ArgumentError, "Missing the required parameter 'system_id' when calling WorkflowInstancesApi.get_system_workflow_instances"
49
- end
50
- if @api_client.config.client_side_validation && opts[:'status'] && !['active', 'inactive', 'all'].include?(opts[:'status'])
51
- fail ArgumentError, 'invalid value for "status", must be one of active, inactive, all'
47
+ allowable_values = ["active", "inactive", "all", "unknown_default_open_api"]
48
+ if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
49
+ fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
52
50
  end
53
51
  # resource path
54
- local_var_path = '/api/systems/{systemId}/workflow-instances'.sub('{' + 'systemId' + '}', system_id.to_s)
52
+ local_var_path = '/api/workflows/instances'
55
53
 
56
54
  # query parameters
57
55
  query_params = opts[:query_params] || {}
@@ -69,55 +67,56 @@ module EmassClient
69
67
  form_params = opts[:form_params] || {}
70
68
 
71
69
  # http body (model)
72
- post_body = opts[:body]
70
+ post_body = opts[:debug_body]
71
+
72
+ # return_type
73
+ return_type = opts[:debug_return_type] || 'WorkflowInstancesResponseGet'
73
74
 
74
- return_type = opts[:return_type] || 'WorkflowInstancesResponseGet'
75
+ # auth_names
76
+ auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
75
77
 
76
- auth_names = opts[:auth_names] || ['apikey', 'mockType', 'userid']
77
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
78
+ new_options = opts.merge(
79
+ :operation => :"WorkflowInstancesApi.get_system_workflow_instances",
78
80
  :header_params => header_params,
79
81
  :query_params => query_params,
80
82
  :form_params => form_params,
81
83
  :body => post_body,
82
84
  :auth_names => auth_names,
83
- :return_type => return_type)
85
+ :return_type => return_type
86
+ )
84
87
 
88
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
85
89
  if @api_client.config.debugging
86
90
  @api_client.config.logger.debug "API called: WorkflowInstancesApi#get_system_workflow_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
91
  end
88
92
  return data, status_code, headers
89
93
  end
90
- # Get workflow instance by ID in a system
91
- # View detailed information on all active and historical workflows for a system `systemId` and `workflowInstanceId`.
92
- # @param system_id **System Id**: The unique system record identifier.
93
- # @param workflow_instance_id **Workflow Instance Id**: The unique milestone record identifier.
94
+
95
+ # Get workflow instance by ID
96
+ # View detailed historical workflow information for `workflowInstanceId`.
97
+ # @param workflow_instance_id [Integer] **Workflow Instance Id**: The unique workflow definition identifier.
94
98
  # @param [Hash] opts the optional parameters
95
- # @return [WorkflowInstancesResponseGet]
96
- def get_system_workflow_instances_by_workflow_instance_id(system_id, workflow_instance_id, opts = {})
97
- data, _status_code, _headers = get_system_workflow_instances_by_workflow_instance_id_with_http_info(system_id, workflow_instance_id, opts)
99
+ # @return [WorkflowInstanceResponseGet]
100
+ def get_system_workflow_instances_by_workflow_instance_id(workflow_instance_id, opts = {})
101
+ data, _status_code, _headers = get_system_workflow_instances_by_workflow_instance_id_with_http_info(workflow_instance_id, opts)
98
102
  data
99
103
  end
100
104
 
101
- # Get workflow instance by ID in a system
102
- # View detailed information on all active and historical workflows for a system &#x60;systemId&#x60; and &#x60;workflowInstanceId&#x60;.
103
- # @param system_id **System Id**: The unique system record identifier.
104
- # @param workflow_instance_id **Workflow Instance Id**: The unique milestone record identifier.
105
+ # Get workflow instance by ID
106
+ # View detailed historical workflow information for &#x60;workflowInstanceId&#x60;.
107
+ # @param workflow_instance_id [Integer] **Workflow Instance Id**: The unique workflow definition identifier.
105
108
  # @param [Hash] opts the optional parameters
106
- # @return [Array<(WorkflowInstancesResponseGet, Integer, Hash)>] WorkflowInstancesResponseGet data, response status code and response headers
107
- def get_system_workflow_instances_by_workflow_instance_id_with_http_info(system_id, workflow_instance_id, opts = {})
109
+ # @return [Array<(WorkflowInstanceResponseGet, Integer, Hash)>] WorkflowInstanceResponseGet data, response status code and response headers
110
+ def get_system_workflow_instances_by_workflow_instance_id_with_http_info(workflow_instance_id, opts = {})
108
111
  if @api_client.config.debugging
109
112
  @api_client.config.logger.debug 'Calling API: WorkflowInstancesApi.get_system_workflow_instances_by_workflow_instance_id ...'
110
113
  end
111
- # verify the required parameter 'system_id' is set
112
- if @api_client.config.client_side_validation && system_id.nil?
113
- fail ArgumentError, "Missing the required parameter 'system_id' when calling WorkflowInstancesApi.get_system_workflow_instances_by_workflow_instance_id"
114
- end
115
114
  # verify the required parameter 'workflow_instance_id' is set
116
115
  if @api_client.config.client_side_validation && workflow_instance_id.nil?
117
116
  fail ArgumentError, "Missing the required parameter 'workflow_instance_id' when calling WorkflowInstancesApi.get_system_workflow_instances_by_workflow_instance_id"
118
117
  end
119
118
  # resource path
120
- local_var_path = '/api/systems/{systemId}/workflow-instances/{workflowInstanceId}'.sub('{' + 'systemId' + '}', system_id.to_s).sub('{' + 'workflowInstanceId' + '}', workflow_instance_id.to_s)
119
+ local_var_path = '/api/workflows/instances/{workflowInstanceId}'.sub('{' + 'workflowInstanceId' + '}', CGI.escape(workflow_instance_id.to_s))
121
120
 
122
121
  # query parameters
123
122
  query_params = opts[:query_params] || {}
@@ -131,19 +130,25 @@ module EmassClient
131
130
  form_params = opts[:form_params] || {}
132
131
 
133
132
  # http body (model)
134
- post_body = opts[:body]
133
+ post_body = opts[:debug_body]
134
+
135
+ # return_type
136
+ return_type = opts[:debug_return_type] || 'WorkflowInstanceResponseGet'
135
137
 
136
- return_type = opts[:return_type] || 'WorkflowInstancesResponseGet'
138
+ # auth_names
139
+ auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']
137
140
 
138
- auth_names = opts[:auth_names] || ['apikey', 'mockType', 'userid']
139
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
141
+ new_options = opts.merge(
142
+ :operation => :"WorkflowInstancesApi.get_system_workflow_instances_by_workflow_instance_id",
140
143
  :header_params => header_params,
141
144
  :query_params => query_params,
142
145
  :form_params => form_params,
143
146
  :body => post_body,
144
147
  :auth_names => auth_names,
145
- :return_type => return_type)
148
+ :return_type => return_type
149
+ )
146
150
 
151
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
147
152
  if @api_client.config.debugging
148
153
  @api_client.config.logger.debug "API called: WorkflowInstancesApi#get_system_workflow_instances_by_workflow_instance_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
149
154
  end