RubyGems - emasser - Versions diffs - 1.0.6 → 3.4.1 - Mend

emasser 1.0.6 → 3.4.1

Files changed (61) hide show

checksums.yaml +4 -4
data/.dockerignore +8 -8
data/.env-example +12 -12
data/.github/release-drafter.yml +15 -15
data/.github/workflows/codeql-analysis.yml +70 -70
data/.github/workflows/draft-release.yml +15 -15
data/.github/workflows/gh-pages.yml +32 -32
data/.github/workflows/push-to-docker-mail.yml +28 -28
data/.github/workflows/push-to-docker.yml +35 -35
data/.github/workflows/release.yml +42 -42
data/.github/workflows/rubocop.yml +23 -23
data/.github/workflows/test-cli.yml +72 -72
data/.gitignore +19 -19
data/.mergify.yml +25 -25
data/.rubocop.yml +80 -80
data/.rubocop_todo.yml +27 -27
data/CHANGELOG.md +16 -16
data/Dockerfile +44 -44
data/Gemfile +8 -8
data/Gemfile.lock +104 -104
data/LICENSE.md +15 -15
data/README.md +178 -178
data/Rakefile +18 -18
data/_config.yml +1 -1
data/docs/features.md +1436 -1330
data/docs/redoc/index.html +1230 -1230
data/emasser.gemspec +44 -44
data/exe/emasser +5 -5
data/lib/emasser/cli.rb +37 -37
data/lib/emasser/configuration.rb +49 -49
data/lib/emasser/constants.rb +26 -26
data/lib/emasser/delete.rb +148 -148
data/lib/emasser/errors.rb +14 -14
data/lib/emasser/get.rb +949 -670
data/lib/emasser/help/approvalCac_post_mapper.md +20 -20
data/lib/emasser/help/approvalPac_post_mapper.md +20 -20
data/lib/emasser/help/artifacts_del_mapper.md +9 -9
data/lib/emasser/help/artifacts_post_mapper.md +59 -59
data/lib/emasser/help/artifacts_put_mapper.md +34 -34
data/lib/emasser/help/cloudresource_post_mapper.md +62 -62
data/lib/emasser/help/cmmc_get_mapper.md +4 -4
data/lib/emasser/help/container_post_mapper.md +44 -44
data/lib/emasser/help/controls_put_mapper.md +74 -74
data/lib/emasser/help/milestone_del_mapper.md +11 -11
data/lib/emasser/help/milestone_post_mapper.md +14 -14
data/lib/emasser/help/milestone_put_mapper.md +23 -23
data/lib/emasser/help/poam_del_mapper.md +5 -5
data/lib/emasser/help/poam_post_mapper.md +93 -93
data/lib/emasser/help/poam_put_mapper.md +107 -107
data/lib/emasser/help/staticcode_clear_mapper.md +16 -16
data/lib/emasser/help/staticcode_post_mapper.md +21 -21
data/lib/emasser/help/testresults_post_mapper.md +21 -21
data/lib/emasser/help.rb +11 -11
data/lib/emasser/input_converters.rb +21 -21
data/lib/emasser/options_parser.rb +20 -20
data/lib/emasser/output_converters.rb +111 -111
data/lib/emasser/post.rb +830 -802
data/lib/emasser/put.rb +588 -588
data/lib/emasser/version.rb +5 -5
data/lib/emasser.rb +19 -19
metadata +10 -16

data/docs/features.md CHANGED Viewed

@@ -1,1331 +1,1437 @@
-# emasser CLI Features
-## Environment Variables
-To facilitate setting the required environment variables the `emasser `CLI utilized the zero-dependency module to load these variables from a `.env` file.
-### Configuring the `.env` File
-An `.env-example` file is provided with the required and optional fields.
-Modify the `.env_example` as necessary and save it as a `.env` file.
-Place the file on the  path where the `emasser` command is executed.
-### Required and Optional Environment Variables
-The following environment variables are required:
-* EMASSER_API_KEY_API_KEY=`<API key>`
-* EMASSER_API_KEY_USER_UID=`<unique identifier for the API Key (EMASSER_API_KEY_API_KEY)`
-* EMASSER_HOST=`<FQDN of the eMASS server>`
-* EMASSER_KEY_FILE_PATH=`<path to your eMASS key in PEM format>`
-* EMASSER_CERT_FILE_PATH=`<path to your eMASS certificate in PEM format>`
-* EMASSER_KEY_PASSWORD=`<password for the key given in EMASSER_KEY_FILE_PATH>`
-The following environment variables are *optional:
-* EMASSER_CLIENT_SIDE_VALIDATION=`<client side validation - true or false (default true)>`
-* EMASSER_VERIFY_SSL=`<verify SSL - true or false (default true)>`
-* EMASSER_VERIFY_SSL_HOST=`<verify host SSL - true or false (default true)>`
-* EMASSER_DEBUGGING=`<set debugging - true or false (default false)>`
-* EMASSER_CLI_DISPLAY_NULL=`<display null value fields - true or false (default true)>`
-* EMASSER_POCH_TO_DATETIME=`<convert epoch to data/time value - true or false (default false)>`
-\* If not provided defaults are used
-The proper format to set these variables in the `.env` files is as follows:
-```bash
-export [VARIABLE_NAME]='value'
-```
-***NOTE***
-`emasser` requires authentication to an eMASS instance as well as authorization to use the eMASS API. This authentication and authorization is **not** a function of `emasser` and needs to be accomplished with the eMASS instances owner organization. Further information about eMASS credential requirements refer to [Defense Counterintelligence and Security Agency](https://www.dcsa.mil/is/emass/) about eMASS access.
----
-## Common emasser Endpoint Requests Information
-  - To invoke any boolean parameters use --parameterName for TRUE and --no-parameterName for FALSE
-  - The eMASS API provides the capability of updating multiple entries within several endpoints, however the `emasser` CLI, in some cases only supports updating one entry at the time.
-## Invoking emasser CLI Commands
-The CLI invoke commands listed in this document shows them when executing from the source code (after a pull from GitHub). Please reference the [`emasser` README](https://mitre.github.io/emasser/) on how to invoke the CLI using other available executables (gem or docker).
-## API Endpoints Provided
-### GET
-* [/api](#get-test-connection)
-* [/api/system](#get-system)
-* [/api/systems](#get-systems)
-* [/api/systems/{systemId}](#get-system)
-* [/api/system-roles](#get-roles)
-* [/api/system-roles/{roleCategory}](#get-roles)
-* [/api/systems/{systemId}/controls](#get-controls)
-* [/api/systems/{systemId}/test-results](#get-testresults)
-* [/api/systems/{systemId}/poams](#get-poams)
-* [/api/systems/{systemId}/poams/{poamId}](#get-poams)
-* [/api/systems/{systemId}/poams/{poamId}/milestones](#get-milestones)
-* [/api/systems/{systemId}/poams/{poamId}/milestones/{milestoneId})](#get-milestones)
-* [/api/systems/{systemId}/artifacts](#get-artifacts)
-* [/api/systems/{systemId}/artifacts-export](#get-artifacts)
-* [/api/systems/{systemId}/approval/cac](#get-cac)
-* [/api/systems/{systemId}/approval/pac](#get-pac)
-* [/api/cmmc-assessments](#get-cmmc)
-* [/api/workflow-definitions](#get-workflowdefinitions)
-* [/api/systems/{systemId}/workflow-instances](#get-workflowinstances)
-### POST
-* [/api/systems/{systemId}/test-results](#post-test_results)
-* [/api/systems/{systemId}/poam](#post-poams)
-* [/api/systems/{systemId}/poam/{poamId}/milestones](#post-milestones)
-* [/api/systems/{systemId}/artifacts](#post-artifacts)
-* [/api/systems/{systemId}/approval/cac](#post-cac)
-* [/api/systems/{systemId}/approval/pac](#post-pac)
-* [/api/systems/{systemId}/static-code-scans](#post-static_code_scan)
-* [/api/systems/{systemId}/cloud-resource-results](#post-cloudresource)
-* [/api/systems/{systemId}/container-scan-results](#post-container)
-### PUT
-* [/api/systems/{systemId}/controls](#put-controls)
-* [/api/systems/{systemId}/poams](#put-poams)
-* [/api/systems/{systemId}/poams/{poamId}/milestones](#put-milestones)
-* [/api/systems/{systemId}/artifacts](#put-artifacts)
-### DELETE
-* [/api/systems/{systemId}/poams](#delete-poams)
-* [/api/systems/{systemId}/poams/{poamId}/milestones](#delete-milestones)
-* [/api/systems/{systemId}/artifacts](#delete-artifacts)
-## Endpoints CLI help
-Each CLI endpoint command has several layers of help.
-- Using `help` after a `get, put, post, or delete` command lists all available endpoint calls. The following command would list all available `GET` endpoints commands.
-    ```bash
-    $ bundle exec exe/emasser get help
-    Commands:
-      emasser get artifacts             # Get system Artifacts
-      emasser get cac                   # Get location of one or many controls in...
-      emasser get cmmc                  # Get CMMC assessment information
-      emasser get controls              # Get system Controls
-      emasser get help [COMMAND]        # Describe subcommands or one specific su...
-      emasser get milestones            # Get system Milestones
-      emasser get pac                   # Get status of active workflows in a system
-      emasser get poams                 # Get system Poams
-      emasser get roles                 # Get all system roles or by category Id
-      emasser get system                # Get a system ID given name/owner, or ge...
-      emasser get systems               # Get all systems
-      emasser get test                  # Test connection to the configured eMASS...
-      emasser get test_results          # Get system Test Results
-      emasser get workflow_definitions  # Get workflow definitions in a site
-      emasser get workflow_instances    # Get workflow instance by system and/or ...
-    ```
-- Preceding any command with `help` provides help for the command. The following command would list all available sub-commands and options for the `get artifacts` endpoint command.
-    ```bash
-    $ bundle exec exe/emasser get help artifacts
-    commands:
-      emasser get artifacts export --filename=FILENAME --systemId=N  # Get artifa...
-      emasser get artifacts forSystem --systemId=N                   # Get all sy...
-      emasser get artifacts help [COMMAND]                           # Describe s...
-    ```
-- Using `help` after any command lists all available options. The following command would list all available options for the `get artifacts export` endpoint command.
-    ```bash
-    $ bundle exec exe/emasser get artifacts help export
-    Usage:
-      emasser get artifacts export --filename=FILENAME --systemId=N
-    Options:
-      --systemId=N                   # A numeric value representing the system identification
-      --filename=FILENAME            # The artifact file name
-      [--compress], [--no-compress]  # BOOLEAN - true or false.
-    ```
-**The same format is applicable for POST, PUT and DELETE requests as well, however there may be additional help content**
-## Usage - GET
-### ```get test connection```
----
-The Test Connection endpoint provides the ability to verify connection to the web service.
-    $ bundle exec exe/emasser get test connection
-A return of success from the call indicates that the CLI can reach the configure server URL.
-References [Required Environment Variables](#required-environment-variables) for the necessary environment variables.
-[top](#api-endpoints-provided)
-### ```get system```
----
-The `get system` command is not a sanctioned eMASS endpoint, it makes use of the `get systems` endpoint with added business logic.
-There are two commands provided by the get system:
-- The `get system id` - returns system ID's based on the system `name` or `owner`
-- The `get system byId` - returns the system content for parameter system ID
-### get system id
-Retrieves a system identification based on the SYSTEM_NAME (name) or SYSTEM_OWNER (systemOwner) fields.
-To invoke the `get system id` use the following command:
-    $ bundle exec exe/emasser get system id --system_name "system name" --system_owner "system owner"
-If using a platform that has `awk` installed the following command can be used to return only the system Id:
-    $ bundle exec exe/emasser get system --system_name "system name" --system_owner "system owner" | awk "{ print $1 }"
-### get system byId
-Retrieves the system content for provided identification (ID) number. To invoke the endpoint use  the following command:
-    $ bundle exec exe/emasser get system byId
-  - required parameter is:
-      |parameter    | type or values                    |
-      |-------------|:----------------------------------|
-      |--systemId   |Integer - Unique system identifier |
-  - Optional parameters are:
-    |parameter               | type or values                          |
-    |------------------------|:----------------------------------------|
-    |--includePackage        |BOOLEAN - true or false                  |
-    |--policy                |Possible values: diacap, rmf, reporting  |
-[top](#api-endpoints-provided)
-### ```get systems```
-----
-To retrieve controls use the following command:
-- all - Retrieves all available systems
-    ```
-    $ bundle exec exe/emasser get systems all
-    ```
-  - Optional parameters are:
-    |parameter               | type or values                                                              |
-    |------------------------|:----------------------------------------------------------------------------|
-    |--coamsId               |Cyber Operational Attributes Management System (COAMS) string Id             |
-    |--ditprId               |DoD Information Technology (IT) Portfolio Repository (DITPR) string id       |
-    |--includeDecommissioned |BOOLEAN - true or false                                                      |
-    |--includeDitprMetrics   |BOOLEAN - true or false                                                      |
-    |--includePackage        |BOOLEAN - true or false                                                      |
-    |--policy                |Possible values: diacap, rmf, reporting                                      |
-    |--registrationType      |Possible values: assessAndAuthorize, assessOnly, guest, regular, functional, |
-    |                        |                 cloudServiceProvider, commonControlProvider                  |
-    |--reportsForScorecard   |BOOLEAN - true or false                                                      |
-[top](#api-endpoints-provided)
-### ```get roles```
-----
-There are two get endpoints for system roles:
-- all - Retrieves all available roles
-    ```
-    $ bundle exec exe/emasser get roles all
-    ```
-- byCategory - Retrieves roles based on the following required parameter:
-    ````
-    $ bundle exec exe/emasser get roles byCategory --roleCategory=ROLECATEGORY --role=ROLE
-    ````
-  - required parameters are:
-    |parameter       | type or values                            |
-    |:---------------|:------------------------------------------|
-    |--roleCategory  |Possible values: PAC, CAC, Other           |
-    |--role          |Possible values: AO, Auditor, Artifact Manager, C&A Team, IAO, ISSO, PM/IAM, SCA, User Rep (View Only), Validator (IV&V)|
-  - optional parameter are:
-    |parameter               | type or values                          |
-    |------------------------|:----------------------------------------|
-    |--policy                |Possible values: diacap, rmf, reporting  |
-    |--includeDecommissioned |BOOLEAN - true or false                  |
-[top](#api-endpoints-provided)
-### ```get controls```
-----
-To retrieve controls use the following command:
-    $ bundle exec exe/emasser get controls forSystem --systemId=SYSTEMID
-  - required parameter is:
-    |parameter    | type or values                    |
-    |-------------|:----------------------------------|
-    |--systemId   |Integer - Unique system identifier |
-  - optional parameter is:
-    |parameter    | type or values                            |
-    |-------------|:------------------------------------------|
-    |--acronyms   |The system acronym(s) e.g "AC-1, AC-2" - if not provided all controls for systemId are returned |
-[top](#api-endpoints-provided)
-### ```get test_results```
-----
-To retrieve test results use the following command:
-    $ bundle exec exe/emasser get test_results forSystem --systemId=SYSTEMID
-  - required parameter is:
-    |parameter    | type or values                    |
-    |-------------|:----------------------------------|
-    |--systemId   |Integer - Unique system identifier |
-  - optional parameters are:
-    |parameter          | type or values                            |
-    |-------------------|:------------------------------------------|
-    |--controlAcronyms  |String - The system acronym(s) e.g "AC-1, AC-2" |
-    |--ccis             |String - The system CCIS string numerical value |
-    |--latestOnly       |BOOLEAN - true or false|
-[top](#api-endpoints-provided)
-### ```get poams```
-----
-There are two get endpoints for system poams:
-- forSystem - Retrieves all poams for specified system ID
-    ````
-    $ bundle exec exe/emasser get poams forSystem --systemId=SYSTEMID
-    ````
-  - required parameter is:
-    |parameter    | type or values                    |
-    |-------------|:----------------------------------|
-    |--systemId   |Integer - Unique system identifier |
-  - optional parameters are:
-    |parameter                      | type or values                                |
-    |-------------------------------|:----------------------------------------------|
-    |--scheduledCompletionDateStart |Date - Unix time format (e.g. 1499644800)      |
-    |--scheduledCompletionDateEnd   |Date - Unix time format (e.g. 1499990400)      |
-    |--controlAcronyms              |String - The system acronym(s) e.g "AC-1, AC-2"|
-    |--ccis                         |String - The system CCIS string numerical value|
-    |--systemOnly                   |BOOLEAN - true or false|
-- byPoamId - Retrieves all poams for specified system and poam ID
-    ````
-    $ bundle exec exe/emasser get poams byPoamId --systemId=SYSTEMID --poamId=POAMID
-    ````
-  - required parameters are:
-    |parameter    | type or values                    |
-    |-------------|:----------------------------------|
-    |--systemId   |Integer - Unique system identifier |
-    |--poamId     |Integer - Unique poam identifier   |
-[top](#api-endpoints-provided)
-### ```get milestones```
-----
-There are two get endpoints for system milestones:
-- byPoamId - Retrieves milestone(s) for specified system and poam ID
-    ````
-    $ bundle exec exe/emasser get milestones byPoamId --systemId=SYSTEMID --poamId=POAMID
-    ````
-  - required parameters are:
-    |parameter    | type or values                    |
-    |-------------|:----------------------------------|
-    |--systemId   |Integer - Unique system identifier |
-    |--poamId     |Integer - Unique poam identifier   |
-  - optional parameters are:
-    |parameter                      | type or values                                |
-    |-------------------------------|:----------------------------------------------|
-    |--scheduledCompletionDateStart |Date - Unix time format (e.g. 1499644800)      |
-    |--scheduledCompletionDateEnd   |Date - Unix time format (e.g. 1499990400)      |
-- byMilestoneId, Retrieve milestone(s) for specified system, poam, and milestone ID"
-    ````
-    $ bundle exec exe/emasser get poams byMilestoneId --systemId=SYSTEMID --poamId=POAMID --milestoneId=MILESTONEID
-    ````
-  - required parameters are:
-    |parameter     | type or values                       |
-    |--------------|:-------------------------------------|
-    |--systemId    |Integer - Unique system identifier    |
-    |--poamId      |Integer - Unique poam identifier      |
-    |--milestoneId |Integer - Unique milestone identifier |
-[top](#api-endpoints-provided)
-### ```get artifacts```
-----
-There are two get endpoints that provides the ability to view existing `Artifacts` in a system:
-- forSystem - Retrieves one or many artifacts in a system specified system ID
-    ````
-    $ bundle exec exe/emasser get artifacts forSystem --systemId=SYSTEMID
-    ````
-  - required parameter is:
-    |parameter    | type or values                    |
-    |-------------|:----------------------------------|
-    |--systemId   |Integer - Unique system identifier |
-  - optional parameters are:
-    |parameter                      | type or values                                |
-    |-------------------------------|:----------------------------------------------|
-    |--filename                     |The artifact file name                         |
-    |--controlAcronyms              |String - The system acronym(s) e.g "AC-1, AC-2"|
-    |--ccis                         |String - The system CCIS string numerical value|
-    |--systemOnly                   |BOOLEAN - true or false|
-- export - Retrieves the file artifacts (if compress is true the file binary contents are returned, otherwise the file textual contents are returned.)
-    ````
-    $ bundle exec exe/emasser get artifacts export --systemId=SYSTEMID
-    ````
-  - required parameters are:
-    |parameter    | type or values                    |
-    |-------------|:----------------------------------|
-    |--systemId   |Integer - Unique system identifier |
-    |--filename   |The artifact file name             |
-  - optional parameter is:
-    |parameter    | type or values                    |
-    |-------------|:----------------------------------|
-    |--compress   |BOOLEAN - true or false.           |
-[top](#api-endpoints-provided)
-### ```get cac```
-----
-To view one or many Control Approval Chain (CAC) in a system specified system ID use the following command:
-  ```
-  $ bundle exec exe/emasser get cac controls --systemId=SYSTEMID
-  ```
-  - required parameter is:
-    |parameter    | type or values                    |
-    |-------------|:----------------------------------|
-    |--systemId   |Integer - Unique system identifier |
-  - optional parameter is:
-    |parameter                      | type or values                                |
-    |-------------------------------|:----------------------------------------------|
-    |--controlAcronyms              |String - The system acronym(s) e.g "AC-1, AC-2"|
-[top](#api-endpoints-provided)
-### ```get pac```
-----
-To view one or many Package Approval Chain (PAC) in a system specified system ID use the following command:
-  ````
-  $ bundle exec exe/emasser get pac package --systemId=SYSTEMID
-  ````
-  - required parameter is:
-    |parameter    | type or values                    |
-    |-------------|:----------------------------------|
-    |--systemId   |Integer - Unique system identifier |
-[top](#api-endpoints-provided)
-### ```get cmmc```
-----
-To view Cybersecurity Maturity Model Certification (CMMC) Assessments use the following command:
-    $ bundle exec exe/emasser get workflow_definitions forSite --sinceDate=SINCEDATE
-  - Required parameters are:
-    |parameter       | type or values                        |
-    |----------------|:--------------------------------------|
-    |--sinceDate     |Date - The CMMC date. Unix date format |
-[top](#api-endpoints-provided)
-### ```get workflow_definitions```
-----
-To view Workflow Definitions use the following command:
-    $ bundle exec exe/emasser get workflow_definitions forSite
-  - Optional parameters are:
-    |parameter            | type or values                                                              |
-    |---------------------|:----------------------------------------------------------------------------|
-    |--includeInactive    |BOOLEAN - true or false                                                      |
-    |--registrationType   |Possible values: assessAndAuthorize, assessOnly, guest, regular, functional, |
-    |                     |                 cloudServiceProvider, commonControlProvider                 |
-[top](#api-endpoints-provided)
-### ```get workflow_instances```
-----
-There are two get endpoints to view workflow instances:
-  - all
-    $ bundle exec exe/emasser get workflow_instances all
-    - Optional parameters are:
-      |parameter          | type or values                                     |
-      |-------------------|:---------------------------------------------------|
-      |--includeComments  |BOOLEAN - true or false                             |
-      |--pageIndex        |Integer - The page number to query                  |
-      |--sinceDate        |Date - The Workflow Instance date. Unix date format |
-      |--status           |Possible values: active, inactive, all              |
-  - byWorkflowInstanceId
-    $ bundle exec exe/emasser get workflow_instances byWorkflowInstanceId --workflowInstanceId=--WORKFLOWID
-    - required parameter is:
-      |parameter            | type or values                               |
-      |---------------------|:---------------------------------------------|
-      |--workflowInstanceId |Integer - Unique workflow instance identifier |
-[top](#api-endpoints-provided)
-## Usage - POST
-### ``post test_results``
----
-Test Result add (POST) endpoint API business rules.
-  |Business Rule                                                        | Parameter/Field  |
-  |---------------------------------------------------------------------|:-----------------|
-  | Tests Results cannot be saved if the "Test Date" is in the future.  | `testDate` |
-  | Test Results cannot be saved if a Security Control is "Inherited" in the system record. | `description` |
-  | Test Results cannot be saved if an Assessment Procedure is "Inherited" in the system record. | `description` |
-  | Test Results cannot be saved if the AP does not exist in the system. | `description` |
-  | Test Results cannot be saved if the control is marked "Not Applicable" by an Overlay. | `description` |
-  | Test Results cannot be saved if the control is required to be assessed as "Applicable" by an Overlay.| `description` |
-  | Test Results cannot be saved if the Tests Results entered is greater than 4000 characters.|`description`|
-  | Test Results cannot be saved if the following fields are missing data: | `complianceStatus`, `testDate`, `testedBy`, `description`|
-  | Test results cannot be saved if there is more than one test result per CCI |`cci`|
----
-To add (POST) test results use the following command:
-  ````
-  $ bundle exec exe/emasser post test_results add --systemId [value] --cci [value] --testedBy [value] --testDate [value] --description [value] --complianceStatus [value]
-  ````
-Note: If no POA&Ms or AP exist for the control (system), you will get this response:
-"You have entered a Non-Compliant Test Result. You must create a POA&M Item for this Control and/or AP if one does not already exist."
-  - required parameter are:
-    |parameter          | type or values                                              |
-    |-------------------|:------------------------------------------------------------|
-    |--systemId         |Integer - Unique system identifier                           |
-    |--cci              |String - CCI associated with the test result. e.g "00221"    |
-    |--testedBy         |String - Last Name, First Name. 100 Characters.              |
-    |--testDate         |Date - Unix time format (e.g. 1499990400)                    |
-    |--description      |String - Include description of test result. 4000 Characters |
-    |--complianceStatus |Possible values: Compliant, Non-Compliant, Not Applicable    |
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser post test_results help add
-```
-[top](#post)
-### ``post poams``
----
-Plan of Action and Milestones (POA&M) add (POST) endpoint API business rules.
-The following fields are required based on the contents of the status field
-  |status          |Required Fields
-  |----------------|--------------------------------------------------------
-  |Risk Accepted   |comments
-  |Ongoing         |scheduledCompletionDate, milestones (at least 1)
-  |Completed       |scheduledCompletionDate, comments, completionDate, milestones (at least 1)
-  |Not Applicable  |POAM can not be created
-If a POC email is supplied, the application will attempt to locate a user
-already registered within the application and pre-populate any information
-not explicitly supplied in the request. If no such user is found, these
-fields are required within the request.
-  - pocOrganization, pocFirstName, pocLastName, pocEmail, pocPhoneNumber
-Business logic, the following rules apply when adding POA&Ms
-- POA&M Items cannot be saved if associated Security Control or AP is inherited.
-- POA&M Items cannot be created manually if a Security Control or AP is Not Applicable.
-- Completed POA&M Item cannot be saved if Completion Date is in the future.
-- Completed POA&M Item cannot be saved if Completion Date (completionDate) is in the future.
-- Risk Accepted POA&M Item cannot be saved with a Scheduled Completion Date or Milestones
-- POA&M Items with a review status of "Not Approved" cannot be saved if Milestone Scheduled Completion Date exceeds POA&M Item  Scheduled Completion Date.
-- POA&M Items with a review status of "Approved" can be saved if Milestone Scheduled Completion Date exceeds POA&M Item Scheduled Completion Date.
-- POA&M Items that have a status of "Completed" and a status of "Ongoing" cannot be saved without Milestones.
-- POA&M Items that have a status of "Risk Accepted" cannot have milestones.
-- POA&M Items with a review status of "Approved" that have a status of "Completed" and "Ongoing" cannot update Scheduled Completion Date.
-- POA&M Items that have a review status of "Approved" are required to have a Severity Value assigned.
-- POA&M Items cannot be updated if they are included in an active package.
-- Archived POA&M Items cannot be updated.
-- POA&M Items with a status of "Not Applicable" will be updated through test result creation.
-- If the Security Control or Assessment Procedure does not exist in the system we may have to just import POA&M Item at the System Level.
-The following POA&M parameters/fields have the following character limitations:
-- Fields that can not exceed 100 characters:
-  - Office / Organization (`pocOrganization`)
-  - First Name            (`pocFirstName`)
-  - Last Name             (`pocLastName`)
-  - Email                 (`email`)
-  - Phone Number          (`pocPhoneNumber`)
-  - External Unique ID    (`externalUid`)
-- Fields that can not exceed 250 characters:
-  - Resource              (`resource`)
-- Fields have can not exceed 2000 character:
-  - Vulnerability Description        (`vulnerabilityDescription`)
-  - Source Identifying Vulnerability (`sourceIdentVuln`)
-  - Recommendations                  (`recommendations`)
-  - Risk Accepted Comments           (`comments`)
-  - Milestone Description            (`description`)
-  - Mitigation Justification         (`mitigation`)
-To add (POST) POA&Ms use the following command:
-```
-$ bundle exec exe/emasser post poams add --systemId [value] --status [value] --vulnerabilityDescription [value] --sourceIdentVuln [value] --pocOrganization [value] --resources [value]
-```
-**Notes:**
-  - The above listed parameters/fields are the minimal required.
-  - Based on the value for the status (--status) parameter additional fields are required
-  - Refer to instructions listed above for conditional and optional fields requirements.
-  - When a milestone is required the format is:
-    - --milestone description:[value] scheduledCompletionDate:[value]
-**If a milestone Id is provided (--milestone milestoneId:[value]) the POA&M with the provided milestone Id is updated and the new POA&M milestones is set to null.**
----
-Client API parameters/fields (required, conditional, and optional).
-  - required parameter are:
-    |parameter                  | type or values                                                 |
-    |---------------------------|:---------------------------------------------------------------|
-    |--systemId                 |Integer - Unique system identifier                              |
-    |--status                   |Possible Values: Ongoing,Risk Accepted,Completed,Not Applicable |
-    |--vulnerabilityDescription |String - Vulnerability description for the POA&M Item           |
-    |--sourceIdentVuln          |String - Include Source Identifying Vulnerability text          |
-    |--pocOrganization          |String - Organization/Office represented       |
-    |--resources                |String - List of resources used. Character Limit = 250          |
-    ** If any poc information is provided all POC fields are required. See additional details for POC fields below.
-  - conditional parameters are:
-    |parameter                 | type or values                                                          |
-    |--------------------------|:------------------------------------------------------------------------|
-    |--milestones              |JSON -  see milestone format                                             |
-    |--pocFirstName            |String - First name of POC                                               |
-    |--pocLastName             |String - Last name of POC                                                |
-    |--pocEmail                |String - Email address of POC                                            |
-    |--pocPhoneNumber          |String - Phone number of POC (area code) ***-**** format                 |
-    |--severity                |Possible values - Very Low, Low, Moderate, High, Very High               |
-    |--scheduledCompletionDate |Date - Required for ongoing and completed POA&M items. Unix time format  |
-    |--completionDate          |Date - Field is required for completed POA&M items. Unix time format     |
-    |--comments                |String - Field is required for completed and risk accepted POA&M items.  |
-    ** If a POC email is supplied, the application will attempt to locate a user already registered within the application and pre-populate any information not explicitly supplied in the request. If no such user is found, these fields are required within the request:
-      pocFirstName, pocLastName, pocPhoneNumber
-    Milestone Format:
-      - --milestone description:[value] scheduledCompletionDate:[value]
-  - optional parameters are:
-    |parameter           | type or values                                                                           |
-    |--------------------|:-----------------------------------------------------------------------------------------|
-    |--externalUid       |String - External unique identifier for use with associating POA&M Items                  |
-    |--controlAcronym    |String - Control acronym associated with the POA&M Item. NIST SP 800-53 Revision 4 defined|
-    |--cci               |String - CCI associated with the test result                                              |
-    |--securityChecks    |String - Security Checks that are associated with the POA&M                               |
-    |--rawSeverity       |Possible values: I, II, III                                                               |
-    |--relevanceOfThreat |Possible values: Very Low, Low, Moderate, High, Very High                                 |
-    |--likelihood        |Possible values: Very Low, Low, Moderate, High, Very High                                 |
-    |--impact            |Possible values: Very Low, Low, Moderate, High, Very High                                 |
-    |--impactDescription |String - Include description of Security Control’s impact                                 |
-    |--residualRiskLevel |Possible values: Very Low, Low, Moderate, High, Very High                                 |
-    |--recommendations   |String - Include recommendations                                                          |
-    |--mitigation        |String - Include mitigation explanation                                                   |
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser post poams help add
-```
-[top](#post)
-### ``post milestones``
----
-To add (POST) milestones in a system for one or more POA&M items use the following command:
-````
-  $ bundle exec exe/emasser post milestones add --systemId [value] --poamId [value] --description [value] --scheduledCompletionDate [value]
-````
-  - required parameter are:
-    |parameter                  | type or values                                      |
-    |---------------------------|:----------------------------------------------------|
-    |--systemId                 |Integer - Unique system identifier                   |
-    |--poamId                   |Integer - Unique item identifier                     |
-    |--description              |String - Milestone item description. 2000 Characters |
-    |--scheduledCompletionDate  |Date - Schedule completion date. Unix date format    |
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser post milestones help add
-```
-[top](#post)
-### ``post artifacts``
----
-The add (POST) artifacts endpoint accepts a single binary file with file extension.zip only. The command line (CI) reads the files provided and zips them before sending to eMASS.
-```
-If no artifact is matched via filename to the application, a new artifact will be created with the following default values. Any values not specified below will be blank.
-  - isTemplate: false
-  - type: other
-  - category: evidence
-```
-Business Rules:
-- Artifact cannot be saved if the file does not have the following file extensions:
-  - .docx,.doc,.txt,.rtf,.xfdl,.xml,.mht,.mhtml,.html,.htm,.pdf
-  - .mdb,.accdb,.ppt,.pptx,.xls,.xlsx,.csv,.log
-  - .jpeg,.jpg,.tiff,.bmp,.tif,.png,.gif
-  - .zip,.rar,.msg,.vsd,.vsw,.vdx, .z{#}, .ckl,.avi,.vsdx
-- Artifact cannot be saved if File Name (fileName) exceeds 1,000 characters
-- Artifact cannot be saved if Description (description) exceeds 2,000 characters
-- Artifact cannot be saved if Reference Page Number (refPageNumber) exceeds 50 characters
-- Artifact version cannot be saved if an Artifact with the same file name already exist in the system.
-- Artifact cannot be saved if the file size exceeds 30MB.
-- Artifact cannot be saved if the Last Review Date is set in the future.
----
-To add (POST) artifacts use the following command:
-```
-$ bundle exec exe/emasser post artifacts upload --systemId [value] [--isTemplate or --no-isTemplate] --type [value] --category [value] --files [value...value]
-```
-  - required parameter are:
-    |parameter       | type or values                                      |
-    |----------------|:----------------------------------------------------|
-    |--systemId      |Integer - Unique system identifier                   |
-    |--isTemplate    |Boolean - Indicates whether an artifact is a template|
-    |--type          |Possible Values: Procedure, Diagram, Policy, Labor, Document, Image, Other, Scan Result, Auditor Report|
-    |--category      |Possible Values: Implementation Guidance, Evidence    |
-    |--files         |String - File names (to include path) to be uploaded into eMASS as artifacts |
-  - optional parameter are:
-    |parameter                | type or values                                        |
-    |-------------------------|:------------------------------------------------------|
-    |--description            |String - Artifact description. 2000 Characters         |
-    |--refPageNumber          |String - Artifact reference page number. 50 Characters |
-    |--ccis                   |String -  CCIs associated with artifact                |
-    |--controls               |String - Control acronym associated with the artifact. NIST SP 800-53 Revision 4 defined|
-    |--artifactExpirationDate |Date - Date Artifact expires and requires review. In Unix Date Format|
-    |--lastReviewedDate       |Date - Date Artifact was last reviewed. In Unix Date Format          |
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser post artifacts help upload
-```
-[top](#post)
-### ``post cac``
-----
-Submit control to second role of CAC
-Business Rule
-- Comments are not required at the first role of the CAC but are required at the second role of the CAC. Comments cannot exceed 10,000 characters.
-To add (POST) test CAC use the following command:
-  ````
-  $ bundle exec exe/emasser post pac add --systemId [value] --controlAcronym [value] --comments [value]
-  ````
-  - required parameter are:
-    |parameter          | type or values                                              |
-    |-------------------|:------------------------------------------------------------|
-    |--systemId         |Integer - Unique system identifier                           |
-    |--controlAcronym   |String - Control acronym associated with the POA&M Item. NIST SP 800-53 Revision 4 defined |
-  - conditional parameter is:
-    |parameter          | type or values                             |
-    |-------------------|:-------------------------------------------|
-    |--comments         |String -The control approval chain comments |
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser post cac help add
-```
-[top](#post)
-### ``post pac``
-----
-Submit control to second role of CAC
-To add (POST) test PAC use the following command:
-  ````
-  $ bundle exec exe/emasser post pac add --systemId [value] --workflow [value] --name [value] --comments [value]
-  ````
-  - required parameter are:
-    |parameter     | type or values                                                            |
-    |--------------|:--------------------------------------------------------------------------|
-    |--systemId    |Integer - Unique system identifier                                         |
-    |--workflow    |Possible Values: Assess and Authorize, Assess Only, Security Plan Approval |
-    |--name        |String - Package name. 100 Characters                                      |
-    |--comments    |String - Comments submitted upon initiation of the indicated workflow, 4,000 character|
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser post pac help add
-```
-[top](#post)
-### ``post static_code_scan``
-----
-To add (POST) static code scans use the following command:
-  ````
-  $ bundle exec exe/emasser post scan_findings add --systemId [value] --applicationName [value] --version [value] --codeCheckName [value] --scanDate [value] --cweId [value]
-  ````
-  - required parameter are:
-    |parameter          | type or values                                             |
-    |-------------------|:-----------------------------------------------------------|
-    |--systemId         |Integer - Unique system identifier                          |
-    |--applicationName  |String - Name of the software application that was assessed |
-    |--version          |String - The version of the application                     |
-    |--codeCheckName    |Strings - Name of the software vulnerability or weakness    |
-    |--scanDate         |Date - The findings scan date - Unix time format            |
-    |--cweId            |String - The Common Weakness Enumerator (CWE) identifier    |
-  - optional parameters are:
-    |parameter          | type or values                                        |
-    |-------------------|:------------------------------------------------------|
-    |--rawSeverity*     |Possible Values: Low, Medium, Moderate, High, Critical |
-    |--count            |Integer - Number of instances observed for a specified |
-*rawSeverity: In eMASS, values of "Critical" will appear as "Very High", and values of "Medium" will appear as "Moderate". Any values not listed as options in the list above will map to "Unknown" and appear as blank values.
-To clear (POST) static code scans use the following command:
-  ````
-  $ bundle exec exe/emasser post scan_findings clear --systemId [value] --applicationName [value] --version [value] --clearFindings
-  ````
-  - required parameter are:
-    |parameter          | type or values                                             |
-    |-------------------|:-----------------------------------------------------------|
-    |--systemId         |Integer - Unique system identifier                          |
-    |--applicationName  |String - Name of the software application that was assessed |
-    |--clearFindings*   |Boolean - To clear an application's findings set it to true |
-*The clearFindings field is an optional field, but required with a value of "True" to clear out all application findings for a single application/version pairing.
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser post scan_findings help add
-```
-[top](#post)
-### ```post cloud_resource```
----
-The following Cloud Resource parameters/fields have the following character limitations:
-- Fields that can not exceed 50 characters:
-  - Policy Deployment Version (`policyDeploymentVersion`)
-- Fields that can not exceed 100 characters:
-  - Assessment Procedure      (`assessmentProcedure`)
-  - Security Control Acronym  (`control`)
-  - CSP Account ID            (`cspAccountId`)
-  - CSP Region                (`cspRegion`)
-  - Email of POC              (`initiatedBy`)
-  - Cloud Service Provider    (`provider`)
-  - Type of Cloud resource    (`resourceType`)
-- Fields that can not exceed 500 characters:
-  - CSP/Resource’s Policy ID  (`cspPolicyDefinitionId`)
-  - Policy Deployment Name    (`policyDeploymentName`)
-  - Policy Compliance ID      (`resourceId`)
-  - Cloud Resource Name       (`resourceName`)
-- Fields that can not exceed 1000 characters:
-  - Reason for Compliance (`complianceReason`)
-- Fields that can not exceed 2000 characters:
-  - Policy Short Title    (`policyDefinitionTitle`)
-To add a cloud resource and their scan results in the assets module for a system use the following command:
-````
-  $ bundle exec exe/emasser post cloud_resource add --systemId [value] --provider [value] --resourceId [value] --resourceName [value] --resourceType [value] --cspPolicyDefinitionId [value] --isCompliant or --is-not-Compliant --policyDefinitionTitle [value] --test [value]
-````
-  - required parameter are:
-    |parameter               | type or values                                                            |
-    |------------------------|:--------------------------------------------------------------------------|
-    |--systemId              |Integer - Unique system identifier                                         |
-    |--provider              |string - Cloud service provider name                                       |
-    |--resourceId            |String - Unique identifier/resource namespace for policy compliance result |
-    |--resourceName          |String - Friendly name of Cloud resource                                   |
-    |--resourceType          |String - Type of Cloud resource                                            |
-    |--cspPolicyDefinitionId |String - Unique identifier/compliance namespace for CSP/Resource\'s policy definition/compliance check|
-    |--isCompliant | Boolean - Compliance status of the policy for the identified cloud resource         |
-    |--policyDefinitionTitle | String - Friendly policy/compliance check title. Recommend short title    |
-  - optional parameters are:
-    |parameter          | type or values                                        |
-    |-------------------|:------------------------------------------------------|
-    |--initiatedBy      |String - Person initiating the process email address |
-    |--cspAccountId     |String - System/owner\'s CSP account ID/number |
-    |--cspRegion        |String - CSP region of system |
-    |--isBaseline       |Boolean - Flag that indicates in results is a baseline |
-    |Tags Object (tags)|
-    |--text | String - Text that specifies the tag type |
-    |Compliance Results Array Objects (complianceResults)|
-    |--assessmentProcedure      |String - Comma separated correlation to Assessment Procedure (i.e. CCI number for DoD Control Set) |
-    |--complianceCheckTimestamp |Date - The compliance check date - Unix time format |
-    |--complianceReason         |String - Reason/comments for compliance result |
-    |--control                  |String - Comma separated correlation to Security Control (e.g. exact NIST Control acronym) |
-    |--policyDeploymentName     |String - Name of policy deployment |
-    |--policyDeploymentVersion  |String - Version of policy deployment |
-    |--severity                 |Possible Values: Low, Medium, High, Critical |
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser post cloud_resource help add
-```
-[top](#post)
-### ```post container```
----
-The following Container parameters/fields have the following character limitations:
-- Fields that can not exceed 100 characters:
-  - STIG Benchmark ID      (`benchmark`)
-  - Container Namespace    (`namespace`)
-  - Kubernetes assigned IP (`podIp`)
-  - Kubernetes Pod Name)   (`podName`)
-- Fields that can not exceed 500 characters:
-  - Container ID              (`containerId`)
-  - Friendly Container Name    (`containerName`)
-- Fields that can not exceed 1000 characters:
-  - Result Comments (`message`)
-To add containers and their scan results in the assets module for a system use the following command:
-````
-  $ bundle exec ruby exe/emasser post container add --systemId [value] --containerId [value] --containerName [value] --time [value] --benchmark [value] --lastSeen [value] --ruleId [value] --status [value]
-````
-  - required parameter are:
-    |parameter               | type or values                                                            |
-    |------------------------|:--------------------------------------------------------------------------|
-    |--systemId              |Integer - Unique system identifier                                         |
-    |--containerId           |String - Unique identifier of the container  |
-    |--containerName         |String - Friendly name of the container      |
-    |--time                  |Date   - Datetime of scan/result. Unix date format |
-    |Bench Marks Object (benchmarks)|
-    |--benchmark         |String - Identifier of the benchmark/grouping of compliance results  |
-    |benchmarks.results  |Object
-    |--ruleId            |String - Identifier for the compliance result, vulnerability, etc.
-    |--status            |String - Benchmark result status
-    |--lastSeen          |Date - Date last seen, Unix date format
-  - optional parameters are:
-    |parameter                   | type or values                                        |
-    |----------------------------|:------------------------------------------------------|
-    |--podName          |String - Name of pod (e.g. Kubernetes pod) |
-    |--podIp            |String - IP address of pod  |
-    |--namespace        |String - Namespace of container in container orchestration (e.g. Kubernetes namespace)|
-    |Tags Object (tags)|
-    |--text | String - Text that specifies the tag type |
-    |Bench Marks Object (benchmarks)
-    |--isBaseline       |Boolean - True/false flag for providing results as baseline. If true, all existing compliance results for the provided benchmark within the container will be replaced by results in the current call|
-    |benchmarks.results  |Object
-    |--message           |String - Comments for the result
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser post container help add
-```
-[top](#post)
-## Usage - PUT
-### ``put controls``
-----
-Business Rules
-The following fields are required based on the value of the `implementationStatus` field
-  |Value                   |Required Fields
-  |------------------------|--------------------------------------------------------
-  |Planned or Implemented  |controlDesignation, estimatedCompletionDate, responsibleEntities, slcmCriticality, slcmFrequency, slcmMethod, slcmMethod, slcmTracking, slcmComments
-  |Not Applicable          |naJustification, controlDesignation, responsibleEntities
-  |Manually Inherited      |controlDesignation, estimatedCompletionDate, responsibleEntities, slcmCriticality, slcmFrequency, slcmMethod, slcmMethod, slcmTracking, slcmComments
-Implementation Plan cannot be updated if a Security Control is "Inherited" except for the following fields:
-  - Common Control Provider (commonControlProvider)
-  - Security Control Designation (controlDesignation)
-The following parameters/fields have the following character limitations:
-- Implementation Plan information cannot be saved if the fields below exceed 2,000 character limits:
-  - N/A Justification        (`naJustification`)
-  - Responsible Entities     (`responsibleEntities`)
-  - Implementation Narrative (`implementationNarrative`)
-  - Criticality              (`slcmCriticality`)
-  - Reporting                (`slcmReporting`)
-  - Tracking                 (`slcmTracking`)
-  - Vulnerability Summary    (`vulnerabilitySummary`)
-  - Recommendations          (`recommendations`)
-- Implementation Plan information cannot be saved if the fields below exceed 4,000 character limits:
-  - SLCM Comments            (`slcmComments`)
-Implementation Plan information cannot be updated if Security Control does not exist in the system record.
----
-Updating (PUT) a Control can be accomplished by invoking the following command:
-  ````
-  $ bundle exec exe/emasser put controls update [PARAMETERS]
-  ````
-  - required parameter are:
-    |parameter                 | type or values                                                           |
-    |--------------------------|:-------------------------------------------------------------------------|
-    |--systemId                |Integer - Unique system identifier                                        |
-    |--acronym                 |String - The system acronym(s) e.g "AC-1, AC-2"                           |
-    |--responsibleEntities     |String - Description of the responsible entities for the Security Control |
-    |--controlDesignation      |Possible values: Common, System-Specific, or Hybrid                       |
-    |--estimatedCompletionDate |Date - Unix time format (e.g. 1499990400)                                 |
-    |--comments                |String - Security control comments                                        |
-  - optional parameters are:
-    |parameter              | type or values                                |
-    |-----------------------|:----------------------------------------------|
-    |--implementationStatus |Possible values: Planned, Implemented, Inherited, Not Applicable, or Manually Inherited|
-    |--severity             |Possible values: Very Low, Low, Moderate, High, Very High |
-    |--vulnerabiltySummary  |String - The security control vulnerability summary |
-    |--recommendations      |String - The security control vulnerability recommendation |
-    |--relevanceOfThreat    |Possible values: Very Low, Low, Moderate, High, Very High |
-    |--likelihood           |Possible values: Very Low, Low, Moderate, High, Very High |
-    |--impact               |Possible values: Very Low, Low, Moderate, High, Very High |
-    |--impactDescription    |String, - Description of the security control impact |
-    |--residualRiskLevel    |Possible values: Very Low, Low, Moderate, High, Very High |
-  - conditional parameters are:
-    |parameter               | type or values                                |
-    |------------------------|:----------------------------------------------|
-    |--commonControlProvider |Possible values: DoD, Component, Enclave|
-    |--naJustification       |String - Justification for Security Controls deemed Not Applicable to the system |
-    |--slcmCriticality       |String - Criticality of Security Control regarding SLCM |
-    |--slcmFrequency         |Possible values - Constantly, Daily, Weekly, Monthly, Quarterly, Semi-Annually, Annually, or Undetermined |
-    |--slcmMethod            |Possible values: Automated, Semi-Automated, Manual, or Undetermined |
-    |--slcmReporting         |String - The System-Level Continuous Monitoring reporting |
-    |--slcmTracking          |String - The System-Level Continuous Monitoring tracking |
-    |--slcmComments          |String, - Additional comments for Security Control regarding SLCM |
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser put controls help update
-```
-[top](#put)
-### ``put poams``
-----
-Business Rules
-The following fields are required based on the value of the `status` field
-  |Value           |Required Fields
-  |----------------|--------------------------------------------------------
-  |Risk Accepted   |comments, resources
-  |Ongoing         |scheduledCompletionDate, resources, milestones (at least 1)
-  |Completed       |scheduledCompletionDate, comments, resources,
-  |                |completionDate, milestones (at least 1)
-  |Not Applicable  |POAM can not be created
-If a POC email is supplied, the application will attempt to locate a user already registered within the application and pre-populate any information not explicitly supplied in the request. If no such user is found, these fields are required within the request.
-  - pocOrganization, pocFirstName, pocLastName, pocEmail, pocPhoneNumber
-Business logic, the following rules apply when adding POA&Ms
-- POA&M Item cannot be saved if associated Security Control or AP is inherited.
-- POA&M Item cannot be created manually if a Security Control or AP is Not Applicable.
-- Completed POA&M Item cannot be saved if Completion Date is in the future.
-- Completed POA&M Item cannot be saved if Completion Date (completionDate) is in the future.
-- Risk Accepted POA&M Item cannot be saved with a Scheduled Completion Date (scheduledCompletionDate) or Milestones
-- POA&M Item with a review status of "Not Approved" cannot be saved if Milestone Scheduled Completion Date exceeds POA&M Item  Scheduled Completion Date.
-- POA&M Item with a review status of "Approved" can be saved if Milestone Scheduled Completion Date exceeds POA&M Item Scheduled Completion Date.
-- POA&M Items that have a status of "Completed" and a status of "Ongoing" cannot be saved without Milestones.
-- POA&M Items that have a status of "Risk Accepted" cannot have milestones.
-- POA&M Items with a review status of "Approved" that have a status of "Completed" and "Ongoing" cannot update Scheduled Completion Date.
-- POA&M Items that have a review status of "Approved" are required to have a Severity Value assigned.
-- POA&M Items cannot be updated if they are included in an active package.
-- Archived POA&M Items cannot be updated.
-- POA&M Items with a status of "Not Applicable" will be updated through test result creation.
-- If the Security Control or Assessment Procedure does not exist in the system we may have to just import POA&M Item at the System Level.
-The following parameters/fields have the following character limitations:
-- POA&M Item cannot be saved if the Point of Contact fields exceed 100 characters:
-  - Office / Organization (pocOrganization)
-  - First Name            (pocFirstName)
-  - Last Name             (pocLastName)
-  - Email                 (email)
-  - Phone Number          (pocPhoneNumber)
-- POA&M Item cannot be saved if Mitigation field (mitigation) exceeds 2,000 characters.
-- POA&M Item cannot be saved if Source Identifying Vulnerability field (sourceIdentVuln) exceeds 2,000 characters.
-- POA&M Item cannot be saved if Comments field (comments) exceeds 2,000 characters
-- POA&M Item cannot be saved if Resource field (resource) exceeds 250 characters.
-- POA&M Items cannot be saved if Milestone Description (description) exceeds 2,000 characters.
-The following POA&M parameters/fields have the following character limitations:
-- Fields that can not exceed 100 characters:
-  - Office / Organization (`pocOrganization`)
-  - First Name            (`pocFirstName`)
-  - Last Name             (`pocLastName`)
-  - Email                 (`email`)
-  - Phone Number          (`pocPhoneNumber`)
-  - External Unique ID    (`externalUid`)
-- Fields that can not exceed 250 characters:
-  - Resource              (`resource`)
-- Fields have can not exceed 2000 character:
-  - Vulnerability Description        (`vulnerabilityDescription`)
-  - Source Identifying Vulnerability (`sourceIdentVuln`)
-  - Recommendations                  (`recommendations`)
-  - Risk Accepted Comments           (`comments`)
-  - Milestone Description            (`description`)
-  - Mitigation Justification         (`mitigation`)
----
-Updating (PUT) a POA&M can be accomplished by invoking the following command:
-  ````
-  $ bundle exec exe/emasser put poams update [PARAMETERS]
-  ````
-  - required parameter are:
-    |parameter                  | type or values                                                 |
-    |---------------------------|:---------------------------------------------------------------|
-    |--systemId                 |Integer - Unique system identifier                              |
-    |--displayPoamId            |Integer - Globally unique identifier for individual POA&M Items |
-    |--status                   |Possible Values: Ongoing,Risk Accepted,Completed,Not Applicable |
-    |--vulnerabilityDescription |String - Vulnerability description for the POA&M Item           |
-    |--sourceIdentVuln          |String - Include Source Identifying Vulnerability text          |
-    |--pocOrganization          |String - Organization/Office represented                        |
-    |--resources                |String - List of resources used. Character Limit = 250          |
-    ** If any poc information is provided all POC fields are required. See additional details for POC fields below.
-  - conditional parameters are:
-    |parameter                 | type or values                                                         |
-    |--------------------------|:-----------------------------------------------------------------------|
-    |--milestones              |JSON -  see milestone format                                            |
-    |--pocFirstName            |String - First name of POC                                              |
-    |--pocLastName             |String - Last name of POC                                               |
-    |--pocEmail                |String - Email address of POC                                           |
-    |--pocPhoneNumber          |String - Phone number of POC (area code) ***-**** format                |
-    |--severity                |Possible values - Very Low, Low, Moderate, High, Very High              |
-    |--scheduledCompletionDate |Date - Required for ongoing and completed POA&M items. Unix time format |
-    |--completionDate          |Date - Field is required for completed POA&M items. Unix time format    |
-    |--comments                |String - Field is required for completed and risk accepted POA&M items  |
-    |--isActive                |Boolean - Used to delete milestones when updating a POA&M               |
-    ** If a POC email is supplied, the application will attempt to locate a user already registered within the application and pre-populate any information not explicitly supplied in the request. If no such user is found, these fields are required within the request:
-      pocFirstName, pocLastName, pocPhoneNumber
-    Milestone Format:
-      - --milestone milestoneId:[value] description:[value] scheduledCompletionDate:[value]
-      - If a milestoneId is not provide a new milestone is created
-  - optional parameters are:
-    |parameter           | type or values                                                                           |
-    |--------------------|:-----------------------------------------------------------------------------------------|
-    |--externalUid       |String - External unique identifier for use with associating POA&M Items                  |
-    |--controlAcronym    |String - Control acronym associated with the POA&M Item. NIST SP 800-53 Revision 4 defined|
-    |--cci               |String - CCI associated with the test result                                              |
-    |--securityChecks    |String - Security Checks that are associated with the POA&M                               |
-    |--rawSeverity       |Possible values: I, II, III                                                               |
-    |--relevanceOfThreat |Possible values: Very Low, Low, Moderate, High, Very High                                 |
-    |--likelihood        |Possible values: Very Low, Low, Moderate, High, Very High                                 |
-    |--impact            |Possible values: Very Low, Low, Moderate, High, Very High                                 |
-    |--impactDescription |String - Include description of Security Control’s impact                                 |
-    |--residualRiskLevel |Possible values: Very Low, Low, Moderate, High, Very High                                 |
-    |--recommendations   |String - Include recommendations                                                          |
-    |--mitigation        |String - Include mitigation explanation. 2000 Characters                                  |
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser put poams help update
-```
-[top](#put)
-### ``put milestones``
-----
-To add (POST) milestones in a system for one or more POA&M items use the following command:
-````
-  $ bundle exec exe/emasser put milestones update [PARAMETERS]
-````
-  - required parameter are:
-    |parameter                  | type or values                                      |
-    |---------------------------|:----------------------------------------------------|
-    |--systemId                 |Integer - Unique system identifier                   |
-    |--poamId                   |Integer - Unique poam identifier                     |
-    |--milestoneId              |Integer - Unique milestone identifier                |
-    |--description              |String - Milestone item description. 2000 Characters |
-    |--scheduledCompletionDate  |Date - Schedule completion date. Unix date format    |
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser put milestones help update
-```
-[top](#put)
-### ``put artifacts``
-----
-Business Rules
-- Artifact cannot be saved if the file does not have the following file extensions:
-  - .docx,.doc,.txt,.rtf,.xfdl,.xml,.mht,.mhtml,.html,.htm,.pdf
-  - .mdb,.accdb,.ppt,.pptx,.xls,.xlsx,.csv,.log
-  - .jpeg,.jpg,.tiff,.bmp,.tif,.png,.gif
-  - .zip,.rar,.msg,.vsd,.vsw,.vdx, .z{#}, .ckl,.avi,.vsdx
-- Artifact cannot be saved if File Name (fileName) exceeds 1,000 characters
-- Artifact cannot be saved if Description (description) exceeds 2,000 characters
-- Artifact cannot be saved if Reference Page Number (refPageNumber) exceeds 50 characters
-- Artifact cannot be saved if the file does not have an allowable file extension/type.
-- Artifact version cannot be saved if an Artifact with the same file name already exist in the system.
-- Artifact cannot be saved if the file size exceeds 30MB.
-- Artifact cannot be saved if the Last Review Date is set in the future.
-To add (POST) milestones in a system for one or more POA&M items use the following command:
-````
-  $ bundle exec exe/emasser put artifacts update [PARAMETERS]
-````
-  - required parameter are:
-    |parameter       | type or values                                      |
-    |----------------|:----------------------------------------------------|
-    |--systemId      |Integer - Unique system identifier                   |
-    |--filename        |String - File name should match exactly one file within the provided zip file|
-    |                |Binary  - Application/zip file. Max 30MB per artifact |
-    |--isTemplate    |Boolean - Indicates whether an artifact is a template|
-    |--type*         |Possible Values: Procedure, Diagram, Policy, Labor, Document, Image, Other, Scan Result, Auditor Report|
-    |--category*     |Possible Values: Implementation Guidance, Evidence    |
-    *May also accept custom artifact category values set by system administrators.
-  - optional parameter are:
-    |parameter                | type or values                                        |
-    |-------------------------|:------------------------------------------------------|
-    |--description            |String - Artifact description. 2000 Characters         |
-    |--refPageNumber          |String - Artifact reference page number. 50 Characters |
-    |--ccis                   |String -  CCIs associated with artifact                |
-    |--controls               |String - Control acronym associated with the artifact. NIST SP 800-53 Revision 4 defined|
-    |--artifactExpirationDate |Date - Date Artifact expires and requires review. In Unix Date Format|
-    |--lastReviewedDate       |Date - Date Artifact was last reviewed. In Unix Date Format          |
-**Note**
-For information at the command line use:
-```
-$ bundle exec exe/emasser put artifacts help update
-```
-[top](#put)
-## Usage - DELETE
-### ``delete poams``
-----
-Remove one or many poa&m items in a system
-To remove (DELETE) one or more POA&M items use the following command:
-```
-bundle exec exe/emasser delete poams remove --systemId [value] --poamId [value]
-```
-[top](#delete)
-### ``delete milestones``
-----
-Remove milestones in a system for one or many POA&M items
-To delete a milestone the record must be inactive by having the field isActive set to false (isActive=false).
-The server returns an empty object upon successfully deleting a milestone.
-The last milestone can not be deleted, at-least on must exist.
-To remove (DELETE) one or more Milestones in a system use the following command:
-```
-bundle exec exe/emasser delete milestones remove--systemId [value] --poamId [value] --milestoneId [value]
-```
-[top](#delete)
-### ``delete artifacts``
----
-Remove one or many artifacts in a system
-Provide single file or a space/comma delimited list of file names to be removed from the system (systemId)
-To remove (DELETE) one or more Artifacts from a system use the following command:
-```
-bundle exec exe/emasser delete artifacts remove --systemId [value] --files [value]
-or
-bundle exec exe/emasser delete artifacts remove --systemId [value] --files [value value...]
-or
-bundle exec exe/emasser delete artifacts remove --systemId [value] --files [value, value...]
-```
+# emasser CLI Features
+## Environment Variables
+To facilitate setting the required environment variables the `emasser `CLI utilized the zero-dependency module to load these variables from a `.env` file.
+### Configuring the `.env` File
+An `.env-example` file is provided with the required and optional fields.
+Modify the `.env_example` as necessary and save it as a `.env` file.
+Place the file on the  path where the `emasser` command is executed.
+### Required and Optional Environment Variables
+The following environment variables are required:
+* EMASSER_API_KEY_API_KEY=`<API key>`
+* EMASSER_API_KEY_USER_UID=`<unique identifier for the API Key (EMASSER_API_KEY_API_KEY)`
+* EMASSER_HOST=`<FQDN of the eMASS server>`
+* EMASSER_KEY_FILE_PATH=`<path to your eMASS key in PEM format>`
+* EMASSER_CERT_FILE_PATH=`<path to your eMASS certificate in PEM format>`
+* EMASSER_KEY_PASSWORD=`<password for the key given in EMASSER_KEY_FILE_PATH>`
+The following environment variables are *optional:
+* EMASSER_CLIENT_SIDE_VALIDATION=`<client side validation - true or false (default true)>`
+* EMASSER_VERIFY_SSL=`<verify SSL - true or false (default true)>`
+* EMASSER_VERIFY_SSL_HOST=`<verify host SSL - true or false (default true)>`
+* EMASSER_DEBUGGING=`<set debugging - true or false (default false)>`
+* EMASSER_CLI_DISPLAY_NULL=`<display null value fields - true or false (default true)>`
+* EMASSER_POCH_TO_DATETIME=`<convert epoch to data/time value - true or false (default false)>`
+\* If not provided defaults are used
+The proper format to set these variables in the `.env` files is as follows:
+```bash
+export [VARIABLE_NAME]='value'
+```
+***NOTE***
+`emasser` requires authentication to an eMASS instance as well as authorization to use the eMASS API. This authentication and authorization is **not** a function of `emasser` and needs to be accomplished with the eMASS instances owner organization. Further information about eMASS credential requirements refer to [Defense Counterintelligence and Security Agency](https://www.dcsa.mil/is/emass/) about eMASS access.
+---
+## Common emasser Endpoint Requests Information
+  - To invoke any boolean parameters use --parameterName for TRUE and --no-parameterName for FALSE
+  - The eMASS API provides the capability of updating multiple entries within several endpoints, however the `emasser` CLI, in some cases only supports updating one entry at the time.
+## Invoking emasser CLI Commands
+The CLI invoke commands listed in this document shows them when executing from the source code (after a pull from GitHub). Please reference the [`emasser` README](https://mitre.github.io/emasser/) on how to invoke the CLI using other available executables (gem or docker).
+## API Endpoints Provided
+### GET
+* [/api](#get-test-connection)
+* [/api/system](#get-system)
+* [/api/systems](#get-systems)
+* [/api/systems/{systemId}](#get-system)
+* [/api/system-roles](#get-roles)
+* [/api/system-roles/{roleCategory}](#get-roles)
+* [/api/systems/{systemId}/controls](#get-controls)
+* [/api/systems/{systemId}/test-results](#get-testresults)
+* [/api/systems/{systemId}/poams](#get-poams)
+* [/api/systems/{systemId}/poams/{poamId}](#get-poams)
+* [/api/systems/{systemId}/poams/{poamId}/milestones](#get-milestones)
+* [/api/systems/{systemId}/poams/{poamId}/milestones/{milestoneId})](#get-milestones)
+* [/api/systems/{systemId}/artifacts](#get-artifacts)
+* [/api/systems/{systemId}/artifacts-export](#get-artifacts)
+* [/api/systems/{systemId}/approval/cac](#get-cac)
+* [/api/systems/{systemId}/approval/pac](#get-pac)
+* [/api/cmmc-assessments](#get-cmmc)
+* [/api/workflow-definitions](#get-workflow_definitions)
+* [/api/systems/{systemId}/workflow-instances](#get-workflow_instances)
+* [/api/dashboards/system-status-details](#get-dashboards)
+* [/api/dashboards/system-control-compliance-summary](#get-dashboards)
+* [/api/dashboards/system-security-controls-details](#get-dashboards)
+* [/api/dashboards/system-assessment-procedures-details](#get-dashboards)
+* [/api/dashboards/system-poam-summary](#get-dashboards)
+* [/api/dashboards/system-poam-details](#get-dashboards)
+* [/api/dashboards/system-hardware-summary](#get-dashboards)
+* [/api/dashboards/system-hardware-details](#get-dashboards)
+* [/api/dashboards/system-associations-details](#get-dashboards)
+* [/api/dashboards/user-system-assignments-details](#get-dashboards)
+* [/api/dashboards/system-privacy-summary](#get-dashboards)
+* [/api/dashboards/va-omb-fisma-saop-summary](#get-dashboards)
+* [/api/dashboards/va-system-aa-summary](#get-dashboards)
+* [/api/dashboards/va-system-a2-summary](#get-dashboards)
+* [/api/dashboards/va-system-pl-109-reporting-summary](#get-dashboards)
+* [/api/dashboards/va-system-fisma-inventory-summary](#get-dashboards)
+### POST
+* [/api/systems/{systemId}/test-results](#post-test_results)
+* [/api/systems/{systemId}/poam](#post-poams)
+* [/api/systems/{systemId}/poam/{poamId}/milestones](#post-milestones)
+* [/api/systems/{systemId}/artifacts](#post-artifacts)
+* [/api/systems/{systemId}/approval/cac](#post-cac)
+* [/api/systems/{systemId}/approval/pac](#post-pac)
+* [/api/systems/{systemId}/static-code-scans](#post-static_code_scan)
+* [/api/systems/{systemId}/cloud-resource-results](#post-cloudresource)
+* [/api/systems/{systemId}/container-scan-results](#post-container)
+### PUT
+* [/api/systems/{systemId}/controls](#put-controls)
+* [/api/systems/{systemId}/poams](#put-poams)
+* [/api/systems/{systemId}/poams/{poamId}/milestones](#put-milestones)
+* [/api/systems/{systemId}/artifacts](#put-artifacts)
+### DELETE
+* [/api/systems/{systemId}/poams](#delete-poams)
+* [/api/systems/{systemId}/poams/{poamId}/milestones](#delete-milestones)
+* [/api/systems/{systemId}/artifacts](#delete-artifacts)
+## Endpoints CLI help
+Each CLI endpoint command has several layers of help.
+- Using `help` after a `get, put, post, or delete` command lists all available endpoint calls. The following command would list all available `GET` endpoints commands.
+    ```bash
+    $ bundle exec exe/emasser get help
+    Commands:
+      emasser get artifacts             # Get system Artifacts
+      emasser get cac                   # Get location of one or many controls in...
+      emasser get cmmc                  # Get CMMC assessment information
+      emasser get controls              # Get system Controls
+      emasser get dashboards            # Get dashboard information
+      emasser get help [COMMAND]        # Describe subcommands or one specific su...
+      emasser get milestones            # Get system Milestones
+      emasser get pac                   # Get status of active workflows in a system
+      emasser get poams                 # Get system Poams
+      emasser get roles                 # Get all system roles or by category Id
+      emasser get system                # Get a system ID given name/owner, or ge...
+      emasser get systems               # Get all systems
+      emasser get test                  # Test connection to the configured eMASS...
+      emasser get test_results          # Get system Test Results
+      emasser get workflow_definitions  # Get workflow definitions in a site
+      emasser get workflow_instances    # Get workflow instance by system and/or ...
+    ```
+- Preceding any command with `help` provides help for the command. The following command would list all available sub-commands and options for the `get artifacts` endpoint command.
+    ```bash
+    $ bundle exec exe/emasser get help artifacts
+    commands:
+      emasser get artifacts export --filename=FILENAME --systemId=N  # Get artifa...
+      emasser get artifacts forSystem --systemId=N                   # Get all sy...
+      emasser get artifacts help [COMMAND]                           # Describe s...
+    ```
+- Using `help` after any command lists all available options. The following command would list all available options for the `get artifacts export` endpoint command.
+    ```bash
+    $ bundle exec exe/emasser get artifacts help export
+    Usage:
+      emasser get artifacts export --filename=FILENAME --systemId=N
+    Options:
+      --systemId=N                   # A numeric value representing the system identification
+      --filename=FILENAME            # The artifact file name
+      [--compress], [--no-compress]  # BOOLEAN - true or false.
+    ```
+**The same format is applicable for POST, PUT and DELETE requests as well, however there may be additional help content**
+## Usage - GET
+### ```get test connection```
+---
+The Test Connection endpoint provides the ability to verify connection to the web service.
+    $ bundle exec exe/emasser get test connection
+A return of success from the call indicates that the CLI can reach the configure server URL.
+References [Required Environment Variables](#required-environment-variables) for the necessary environment variables.
+[top](#api-endpoints-provided)
+### ```get system```
+---
+The `get system` command is not a sanctioned eMASS endpoint, it makes use of the `get systems` endpoint with added business logic.
+There are two commands provided by the get system:
+- The `get system id` - returns system ID's based on the system `name` or `owner`
+- The `get system byId` - returns the system content for parameter system ID
+### get system id
+Retrieves a system identification based on the SYSTEM_NAME (name) or SYSTEM_OWNER (systemOwner) fields.
+To invoke the `get system id` use the following command:
+    $ bundle exec exe/emasser get system id --system_name "system name" --system_owner "system owner"
+If using a platform that has `awk` installed the following command can be used to return only the system Id:
+    $ bundle exec exe/emasser get system --system_name "system name" --system_owner "system owner" | awk "{ print $1 }"
+### get system byId
+Retrieves the system content for provided identification (ID) number. To invoke the endpoint use  the following command:
+    $ bundle exec exe/emasser get system byId
+  - required parameter is:
+      |parameter    | type or values                    |
+      |-------------|:----------------------------------|
+      |--systemId   |Integer - Unique system identifier |
+  - Optional parameters are:
+    |parameter               | type or values                          |
+    |------------------------|:----------------------------------------|
+    |--includePackage        |BOOLEAN - true or false                  |
+    |--policy                |Possible values: diacap, rmf, reporting  |
+[top](#api-endpoints-provided)
+### ```get systems```
+----
+To retrieve controls use the following command:
+- all - Retrieves all available systems
+    ```
+    $ bundle exec exe/emasser get systems all
+    ```
+  - Optional parameters are:
+    |parameter               | type or values                                                              |
+    |------------------------|:----------------------------------------------------------------------------|
+    |--coamsId               |Cyber Operational Attributes Management System (COAMS) string Id             |
+    |--ditprId               |DoD Information Technology (IT) Portfolio Repository (DITPR) string id       |
+    |--includeDecommissioned |BOOLEAN - true or false                                                      |
+    |--includeDitprMetrics   |BOOLEAN - true or false                                                      |
+    |--includePackage        |BOOLEAN - true or false                                                      |
+    |--policy                |Possible values: diacap, rmf, reporting                                      |
+    |--registrationType      |Possible values: assessAndAuthorize, assessOnly, guest, regular, functional, |
+    |                        |                 cloudServiceProvider, commonControlProvider                  |
+    |--reportsForScorecard   |BOOLEAN - true or false                                                      |
+[top](#api-endpoints-provided)
+### ```get roles```
+----
+There are two get endpoints for system roles:
+- all - Retrieves all available roles
+    ```
+    $ bundle exec exe/emasser get roles all
+    ```
+- byCategory - Retrieves roles based on the following required parameter:
+    ````
+    $ bundle exec exe/emasser get roles byCategory --roleCategory=ROLECATEGORY --role=ROLE
+    ````
+  - required parameters are:
+    |parameter       | type or values                            |
+    |:---------------|:------------------------------------------|
+    |--roleCategory  |Possible values: PAC, CAC, Other           |
+    |--role          |Possible values: AO, Auditor, Artifact Manager, C&A Team, IAO, ISSO, PM/IAM, SCA, User Rep (View Only), Validator (IV&V)|
+  - optional parameter are:
+    |parameter               | type or values                          |
+    |------------------------|:----------------------------------------|
+    |--policy                |Possible values: diacap, rmf, reporting  |
+    |--includeDecommissioned |BOOLEAN - true or false                  |
+[top](#api-endpoints-provided)
+### ```get controls```
+----
+To retrieve controls use the following command:
+    $ bundle exec exe/emasser get controls forSystem --systemId=SYSTEMID
+  - required parameter is:
+    |parameter    | type or values                    |
+    |-------------|:----------------------------------|
+    |--systemId   |Integer - Unique system identifier |
+  - optional parameter is:
+    |parameter    | type or values                            |
+    |-------------|:------------------------------------------|
+    |--acronyms   |The system acronym(s) e.g "AC-1, AC-2" - if not provided all controls for systemId are returned |
+[top](#api-endpoints-provided)
+### ```get test_results```
+----
+To retrieve test results use the following command:
+    $ bundle exec exe/emasser get test_results forSystem --systemId=SYSTEMID
+  - required parameter is:
+    |parameter    | type or values                    |
+    |-------------|:----------------------------------|
+    |--systemId   |Integer - Unique system identifier |
+  - optional parameters are:
+    |parameter          | type or values                            |
+    |-------------------|:------------------------------------------|
+    |--controlAcronyms  |String - The system acronym(s) e.g "AC-1, AC-2" |
+    |--ccis             |String - The system CCIS string numerical value |
+    |--latestOnly       |BOOLEAN - true or false|
+[top](#api-endpoints-provided)
+### ```get poams```
+----
+There are two get endpoints for system poams:
+- forSystem - Retrieves all poams for specified system ID
+    ````
+    $ bundle exec exe/emasser get poams forSystem --systemId=SYSTEMID
+    ````
+  - required parameter is:
+    |parameter    | type or values                    |
+    |-------------|:----------------------------------|
+    |--systemId   |Integer - Unique system identifier |
+  - optional parameters are:
+    |parameter                      | type or values                                |
+    |-------------------------------|:----------------------------------------------|
+    |--scheduledCompletionDateStart |Date - Unix time format (e.g. 1499644800)      |
+    |--scheduledCompletionDateEnd   |Date - Unix time format (e.g. 1499990400)      |
+    |--controlAcronyms              |String - The system acronym(s) e.g "AC-1, AC-2"|
+    |--ccis                         |String - The system CCIS string numerical value|
+    |--systemOnly                   |BOOLEAN - true or false|
+- byPoamId - Retrieves all poams for specified system and poam ID
+    ````
+    $ bundle exec exe/emasser get poams byPoamId --systemId=SYSTEMID --poamId=POAMID
+    ````
+  - required parameters are:
+    |parameter    | type or values                    |
+    |-------------|:----------------------------------|
+    |--systemId   |Integer - Unique system identifier |
+    |--poamId     |Integer - Unique poam identifier   |
+[top](#api-endpoints-provided)
+### ```get milestones```
+----
+There are two get endpoints for system milestones:
+- byPoamId - Retrieves milestone(s) for specified system and poam ID
+    ````
+    $ bundle exec exe/emasser get milestones byPoamId --systemId=SYSTEMID --poamId=POAMID
+    ````
+  - required parameters are:
+    |parameter    | type or values                    |
+    |-------------|:----------------------------------|
+    |--systemId   |Integer - Unique system identifier |
+    |--poamId     |Integer - Unique poam identifier   |
+  - optional parameters are:
+    |parameter                      | type or values                                |
+    |-------------------------------|:----------------------------------------------|
+    |--scheduledCompletionDateStart |Date - Unix time format (e.g. 1499644800)      |
+    |--scheduledCompletionDateEnd   |Date - Unix time format (e.g. 1499990400)      |
+- byMilestoneId, Retrieve milestone(s) for specified system, poam, and milestone ID"
+    ````
+    $ bundle exec exe/emasser get poams byMilestoneId --systemId=SYSTEMID --poamId=POAMID --milestoneId=MILESTONEID
+    ````
+  - required parameters are:
+    |parameter     | type or values                       |
+    |--------------|:-------------------------------------|
+    |--systemId    |Integer - Unique system identifier    |
+    |--poamId      |Integer - Unique poam identifier      |
+    |--milestoneId |Integer - Unique milestone identifier |
+[top](#api-endpoints-provided)
+### ```get artifacts```
+----
+There are two get endpoints that provides the ability to view existing `Artifacts` in a system:
+- forSystem - Retrieves one or many artifacts in a system specified system ID
+    ````
+    $ bundle exec exe/emasser get artifacts forSystem --systemId=SYSTEMID
+    ````
+  - required parameter is:
+    |parameter    | type or values                    |
+    |-------------|:----------------------------------|
+    |--systemId   |Integer - Unique system identifier |
+  - optional parameters are:
+    |parameter                      | type or values                                |
+    |-------------------------------|:----------------------------------------------|
+    |--filename                     |The artifact file name                         |
+    |--controlAcronyms              |String - The system acronym(s) e.g "AC-1, AC-2"|
+    |--ccis                         |String - The system CCIS string numerical value|
+    |--systemOnly                   |BOOLEAN - true or false|
+- export - Retrieves the file artifacts (if compress is true the file binary contents are returned, otherwise the file textual contents are returned.)
+  ````
+  $ bundle exec exe/emasser get artifacts export --systemId=SYSTEMID
+  ````
+  - required parameters are:
+    |parameter    | type or values                    |
+    |-------------|:----------------------------------|
+    |--systemId   |Integer - Unique system identifier |
+    |--filename   |The artifact file name             |
+  - optional parameter is:
+    |parameter    | type or values                    |
+    |-------------|:----------------------------------|
+    |--compress   |BOOLEAN - true or false.           |
+[top](#api-endpoints-provided)
+### ```get cac```
+----
+To view one or many Control Approval Chain (CAC) in a system specified system ID use the following command:
+  ```
+  $ bundle exec exe/emasser get cac controls --systemId=SYSTEMID
+  ```
+  - required parameter is:
+    |parameter    | type or values                    |
+    |-------------|:----------------------------------|
+    |--systemId   |Integer - Unique system identifier |
+  - optional parameter is:
+    |parameter                      | type or values                                |
+    |-------------------------------|:----------------------------------------------|
+    |--controlAcronyms              |String - The system acronym(s) e.g "AC-1, AC-2"|
+[top](#api-endpoints-provided)
+### ```get pac```
+----
+To view one or many Package Approval Chain (PAC) in a system specified system ID use the following command:
+  ````
+  $ bundle exec exe/emasser get pac package --systemId=SYSTEMID
+  ````
+  - required parameter is:
+    |parameter    | type or values                    |
+    |-------------|:----------------------------------|
+    |--systemId   |Integer - Unique system identifier |
+[top](#api-endpoints-provided)
+### ```get cmmc```
+----
+To view Cybersecurity Maturity Model Certification (CMMC) Assessments use the following command:
+    $ bundle exec exe/emasser get workflow_definitions forSite --sinceDate=SINCEDATE
+  - Required parameter is:
+    |parameter       | type or values                        |
+    |----------------|:--------------------------------------|
+    |--sinceDate     |Date - The CMMC date. Unix date format |
+[top](#api-endpoints-provided)
+### ```get workflow_definitions```
+----
+To view Workflow Definitions use the following command:
+    $ bundle exec exe/emasser get workflow_definitions forSite
+  - Optional parameters are:
+    |parameter            | type or values                                                              |
+    |---------------------|:----------------------------------------------------------------------------|
+    |--includeInactive    |BOOLEAN - true or false                                                      |
+    |--registrationType   |Possible values: assessAndAuthorize, assessOnly, guest, regular, functional, |
+    |                     |                 cloudServiceProvider, commonControlProvider                 |
+[top](#api-endpoints-provided)
+### ```get workflow_instances```
+----
+There are two get endpoints to view workflow instances:
+  - all
+    ```
+    $ bundle exec exe/emasser get workflow_instances all
+    ```
+    - Optional parameters are:
+      |parameter          | type or values                                     |
+      |-------------------|:---------------------------------------------------|
+      |--includeComments  |BOOLEAN - true or false                             |
+      |--pageIndex        |Integer - The page number to query                  |
+      |--sinceDate        |Date - The Workflow Instance date. Unix date format |
+      |--status           |Possible values: active, inactive, all              |
+  - byWorkflowInstanceId
+    ```
+    $ bundle exec exe/emasser get workflow_instances byWorkflowInstanceId --workflowInstanceId=WORKFLOWID
+    ```
+    - required parameter is:
+      |parameter            | type or values                               |
+      |---------------------|:---------------------------------------------|
+      |--workflowInstanceId |Integer - Unique workflow instance identifier |
+[top](#api-endpoints-provided)
+### ```get dashboards```
+----
+The Dashboards endpoints provide the ability to view data contained in dashboard exports. In the eMASS front end, these dashboard exports are generated as Excel exports.
+All endpoint calls utilize the same parameter values, they are:
+  - Required parameter is:
+    |parameter     | type or values                                  |
+    |--------------|:------------------------------------------------|
+    |--orgId       |Integer - The organization identification number |
+  - Optional parameters are:
+    |parameter    | type or values                                                |
+    |-------------|:--------------------------------------------------------------|
+    |--pageIndex  |Integer - The index of the starting page (default first page 0)|
+    |--pageSize   |Integer - The number of entries per page (default 20000)       |
+Available commands are:
+  - Get systems status detail dashboard information
+    ```
+    $ bundle exec exe/emasser get status_details --orgId=ORGID
+    ```
+  - Get systems control compliance summary dashboard information
+    ```
+    $ bundle exec exe/emasser get control_compliance_summary --orgId=ORGID
+    ```
+  - Get systems security control details dashboard information
+    ```
+    $ bundle exec exe/emasser get security_control_details --orgId=ORGID
+    ```
+  - Get systems assessment procedures details dashboard information
+    ```
+    $ bundle exec exe/emasser get assessment_procedures_details --orgId=ORGID
+    ```
+  - Get systems POA&Ms summary dashboard information
+    ```
+    $ bundle exec exe/emasser get poam_summary --orgId=ORGID
+    ```
+  - Get system POA&Ms details dashboard information
+    ```
+    $ bundle exec exe/emasser get poam_details --orgId=ORGID
+    ```
+  - Get system hardware summary dashboard information
+    ```
+    $ bundle exec exe/emasser get hardware_summary --orgId=ORGID
+    ```
+  - Get system hardware details dashboard information
+    ```
+    $ bundle exec exe/emasser get hardware_details --orgId=ORGID
+    ```
+  - Get system associations details dashboard information
+    ```
+    $ bundle exec exe/emasser get associations_details --orgId=ORGID
+    ```
+  - Get user system assignments details dashboard information
+    ```
+    $ bundle exec exe/emasser get assignments_details --orgId=ORGID
+    ```
+  - Get user system privacy summary dashboard information
+    ```
+    $ bundle exec exe/emasser get privacy_summary --orgId=ORGID
+    ```
+  - Get VA OMB-FISMA SAOP summary dashboard information
+    ```
+    $ bundle exec exe/emasser get fisma_saop_summary --orgId=ORGID
+    ```
+  - Get VA system A&A summary dashboard information
+    ```
+    $ bundle exec exe/emasser get va_aa_summary --orgId=ORGID
+    ```
+  - Get VA system A2.0 summary dashboard information
+    ```
+    $ bundle exec exe/emasser get va_a2_summary --orgId=ORGID
+    ```
+  - Get VA System P.L. 109 reporting summary dashboard information
+    ```
+    $ bundle exec exe/emasser get va_pl_109_summary --orgId=ORGID
+    ```
+  - Get VA system FISMA inventory summary dashboard information
+    ```
+    $ bundle exec exe/emasser get fisma_inventory_summary --orgId=ORGID
+    ```
+[top](#api-endpoints-provided)
+## Usage - POST
+### ``post test_results``
+---
+Test Result add (POST) endpoint API business rules.
+  |Business Rule                                                        | Parameter/Field  |
+  |---------------------------------------------------------------------|:-----------------|
+  | Tests Results cannot be saved if the "Test Date" is in the future.  | `testDate` |
+  | Test Results cannot be saved if a Security Control is "Inherited" in the system record. | `description` |
+  | Test Results cannot be saved if an Assessment Procedure is "Inherited" in the system record. | `description` |
+  | Test Results cannot be saved if the AP does not exist in the system. | `description` |
+  | Test Results cannot be saved if the control is marked "Not Applicable" by an Overlay. | `description` |
+  | Test Results cannot be saved if the control is required to be assessed as "Applicable" by an Overlay.| `description` |
+  | Test Results cannot be saved if the Tests Results entered is greater than 4000 characters.|`description`|
+  | Test Results cannot be saved if the following fields are missing data: | `complianceStatus`, `testDate`, `testedBy`, `description`|
+  | Test results cannot be saved if there is more than one test result per CCI |`cci`|
+---
+To add (POST) test results use the following command:
+  ````
+  $ bundle exec exe/emasser post test_results add --systemId [value] --cci [value] --testedBy [value] --testDate [value] --description [value] --complianceStatus [value]
+  ````
+Note: If no POA&Ms or AP exist for the control (system), you will get this response:
+"You have entered a Non-Compliant Test Result. You must create a POA&M Item for this Control and/or AP if one does not already exist."
+  - required parameter are:
+    |parameter          | type or values                                              |
+    |-------------------|:------------------------------------------------------------|
+    |--systemId         |Integer - Unique system identifier                           |
+    |--cci              |String - CCI associated with the test result. e.g "00221"    |
+    |--testedBy         |String - Last Name, First Name. 100 Characters.              |
+    |--testDate         |Date - Unix time format (e.g. 1499990400)                    |
+    |--description      |String - Include description of test result. 4000 Characters |
+    |--complianceStatus |Possible values: Compliant, Non-Compliant, Not Applicable    |
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser post test_results help add
+```
+[top](#post)
+### ``post poams``
+---
+Plan of Action and Milestones (POA&M) add (POST) endpoint API business rules.
+The following fields are required based on the contents of the status field
+  |status          |Required Fields
+  |----------------|--------------------------------------------------------
+  |Risk Accepted   |comments
+  |Ongoing         |scheduledCompletionDate, milestones (at least 1)
+  |Completed       |scheduledCompletionDate, comments, completionDate, milestones (at least 1)
+  |Not Applicable  |POAM can not be created
+If a POC email is supplied, the application will attempt to locate a user
+already registered within the application and pre-populate any information
+not explicitly supplied in the request. If no such user is found, these
+fields are required within the request.
+  - pocOrganization, pocFirstName, pocLastName, pocEmail, pocPhoneNumber
+Business logic, the following rules apply when adding POA&Ms
+- POA&M Items cannot be saved if associated Security Control or AP is inherited.
+- POA&M Items cannot be created manually if a Security Control or AP is Not Applicable.
+- Completed POA&M Item cannot be saved if Completion Date is in the future.
+- Completed POA&M Item cannot be saved if Completion Date (completionDate) is in the future.
+- Risk Accepted POA&M Item cannot be saved with a Scheduled Completion Date or Milestones
+- POA&M Items with a review status of "Not Approved" cannot be saved if Milestone Scheduled Completion Date exceeds POA&M Item  Scheduled Completion Date.
+- POA&M Items with a review status of "Approved" can be saved if Milestone Scheduled Completion Date exceeds POA&M Item Scheduled Completion Date.
+- POA&M Items that have a status of "Completed" and a status of "Ongoing" cannot be saved without Milestones.
+- POA&M Items that have a status of "Risk Accepted" cannot have milestones.
+- POA&M Items with a review status of "Approved" that have a status of "Completed" and "Ongoing" cannot update Scheduled Completion Date.
+- POA&M Items that have a review status of "Approved" are required to have a Severity Value assigned.
+- POA&M Items cannot be updated if they are included in an active package.
+- Archived POA&M Items cannot be updated.
+- POA&M Items with a status of "Not Applicable" will be updated through test result creation.
+- If the Security Control or Assessment Procedure does not exist in the system we may have to just import POA&M Item at the System Level.
+The following POA&M parameters/fields have the following character limitations:
+- Fields that can not exceed 100 characters:
+  - Office / Organization (`pocOrganization`)
+  - First Name            (`pocFirstName`)
+  - Last Name             (`pocLastName`)
+  - Email                 (`email`)
+  - Phone Number          (`pocPhoneNumber`)
+  - External Unique ID    (`externalUid`)
+- Fields that can not exceed 250 characters:
+  - Resource              (`resource`)
+- Fields have can not exceed 2000 character:
+  - Vulnerability Description        (`vulnerabilityDescription`)
+  - Source Identifying Vulnerability (`sourceIdentVuln`)
+  - Recommendations                  (`recommendations`)
+  - Risk Accepted Comments           (`comments`)
+  - Milestone Description            (`description`)
+  - Mitigation Justification         (`mitigation`)
+To add (POST) POA&Ms use the following command:
+```
+$ bundle exec exe/emasser post poams add --systemId [value] --status [value] --vulnerabilityDescription [value] --sourceIdentVuln [value] --pocOrganization [value] --resources [value]
+```
+**Notes:**
+  - The above listed parameters/fields are the minimal required.
+  - Based on the value for the status (--status) parameter additional fields are required
+  - Refer to instructions listed above for conditional and optional fields requirements.
+  - When a milestone is required the format is:
+    - --milestone description:[value] scheduledCompletionDate:[value]
+**If a milestone Id is provided (--milestone milestoneId:[value]) the POA&M with the provided milestone Id is updated and the new POA&M milestones is set to null.**
+---
+Client API parameters/fields (required, conditional, and optional).
+  - required parameter are:
+    |parameter                  | type or values                                                 |
+    |---------------------------|:---------------------------------------------------------------|
+    |--systemId                 |Integer - Unique system identifier                              |
+    |--status                   |Possible Values: Ongoing,Risk Accepted,Completed,Not Applicable |
+    |--vulnerabilityDescription |String - Vulnerability description for the POA&M Item           |
+    |--sourceIdentVuln          |String - Include Source Identifying Vulnerability text          |
+    |--pocOrganization          |String - Organization/Office represented       |
+    |--resources                |String - List of resources used. Character Limit = 250          |
+    ** If any poc information is provided all POC fields are required. See additional details for POC fields below.
+  - conditional parameters are:
+    |parameter                 | type or values                                                          |
+    |--------------------------|:------------------------------------------------------------------------|
+    |--milestones              |JSON -  see milestone format                                             |
+    |--pocFirstName            |String - First name of POC                                               |
+    |--pocLastName             |String - Last name of POC                                                |
+    |--pocEmail                |String - Email address of POC                                            |
+    |--pocPhoneNumber          |String - Phone number of POC (area code) ***-**** format                 |
+    |--severity                |Possible values - Very Low, Low, Moderate, High, Very High               |
+    |--scheduledCompletionDate |Date - Required for ongoing and completed POA&M items. Unix time format  |
+    |--completionDate          |Date - Field is required for completed POA&M items. Unix time format     |
+    |--comments                |String - Field is required for completed and risk accepted POA&M items.  |
+    ** If a POC email is supplied, the application will attempt to locate a user already registered within the application and pre-populate any information not explicitly supplied in the request. If no such user is found, these fields are required within the request:
+      pocFirstName, pocLastName, pocPhoneNumber
+    Milestone Format:
+      - --milestone description:[value] scheduledCompletionDate:[value]
+  - optional parameters are:
+    |parameter           | type or values                                                                           |
+    |--------------------|:-----------------------------------------------------------------------------------------|
+    |--externalUid       |String - External unique identifier for use with associating POA&M Items                  |
+    |--controlAcronym    |String - Control acronym associated with the POA&M Item. NIST SP 800-53 Revision 4 defined|
+    |--cci               |String - CCI associated with the test result                                              |
+    |--securityChecks    |String - Security Checks that are associated with the POA&M                               |
+    |--rawSeverity       |Possible values: I, II, III                                                               |
+    |--relevanceOfThreat |Possible values: Very Low, Low, Moderate, High, Very High                                 |
+    |--likelihood        |Possible values: Very Low, Low, Moderate, High, Very High                                 |
+    |--impact            |Possible values: Very Low, Low, Moderate, High, Very High                                 |
+    |--impactDescription |String - Include description of Security Control’s impact                                 |
+    |--residualRiskLevel |Possible values: Very Low, Low, Moderate, High, Very High                                 |
+    |--recommendations   |String - Include recommendations                                                          |
+    |--mitigation        |String - Include mitigation explanation                                                   |
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser post poams help add
+```
+[top](#post)
+### ``post milestones``
+---
+To add (POST) milestones in a system for one or more POA&M items use the following command:
+````
+  $ bundle exec exe/emasser post milestones add --systemId [value] --poamId [value] --description [value] --scheduledCompletionDate [value]
+````
+  - required parameter are:
+    |parameter                  | type or values                                      |
+    |---------------------------|:----------------------------------------------------|
+    |--systemId                 |Integer - Unique system identifier                   |
+    |--poamId                   |Integer - Unique item identifier                     |
+    |--description              |String - Milestone item description. 2000 Characters |
+    |--scheduledCompletionDate  |Date - Schedule completion date. Unix date format    |
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser post milestones help add
+```
+[top](#post)
+### ``post artifacts``
+---
+The add (POST) artifacts endpoint accepts a single binary file with file extension.zip only. The command line (CI) reads the files provided and zips them before sending to eMASS.
+```
+If no artifact is matched via filename to the application, a new artifact will be created with the following default values. Any values not specified below will be blank.
+  - isTemplate: false
+  - type: other
+  - category: evidence
+```
+Business Rules:
+- Artifact cannot be saved if the file does not have the following file extensions:
+  - .docx,.doc,.txt,.rtf,.xfdl,.xml,.mht,.mhtml,.html,.htm,.pdf
+  - .mdb,.accdb,.ppt,.pptx,.xls,.xlsx,.csv,.log
+  - .jpeg,.jpg,.tiff,.bmp,.tif,.png,.gif
+  - .zip,.rar,.msg,.vsd,.vsw,.vdx, .z{#}, .ckl,.avi,.vsdx
+- Artifact cannot be saved if File Name (fileName) exceeds 1,000 characters
+- Artifact cannot be saved if Description (description) exceeds 2,000 characters
+- Artifact cannot be saved if Reference Page Number (refPageNumber) exceeds 50 characters
+- Artifact version cannot be saved if an Artifact with the same file name already exist in the system.
+- Artifact cannot be saved if the file size exceeds 30MB.
+- Artifact cannot be saved if the Last Review Date is set in the future.
+---
+To add (POST) artifacts use the following command:
+```
+$ bundle exec exe/emasser post artifacts upload --systemId [value] [--isTemplate or --no-isTemplate] --type [value] --category [value] --files [value...value]
+```
+  - required parameter are:
+    |parameter       | type or values                                      |
+    |----------------|:----------------------------------------------------|
+    |--systemId      |Integer - Unique system identifier                   |
+    |--isTemplate    |Boolean - Indicates whether an artifact is a template|
+    |--type          |Possible Values: Procedure, Diagram, Policy, Labor, Document, Image, Other, Scan Result, Auditor Report|
+    |--category      |Possible Values: Implementation Guidance, Evidence    |
+    |--files         |String - File names (to include path) to be uploaded into eMASS as artifacts |
+  - optional parameter are:
+    |parameter                | type or values                                        |
+    |-------------------------|:------------------------------------------------------|
+    |--description            |String - Artifact description. 2000 Characters         |
+    |--refPageNumber          |String - Artifact reference page number. 50 Characters |
+    |--ccis                   |String -  CCIs associated with artifact                |
+    |--controls               |String - Control acronym associated with the artifact. NIST SP 800-53 Revision 4 defined|
+    |--artifactExpirationDate |Date - Date Artifact expires and requires review. In Unix Date Format|
+    |--lastReviewedDate       |Date - Date Artifact was last reviewed. In Unix Date Format          |
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser post artifacts help upload
+```
+[top](#post)
+### ``post cac``
+----
+Submit control to second role of CAC
+Business Rule
+- Comments are not required at the first role of the CAC but are required at the second role of the CAC. Comments cannot exceed 10,000 characters.
+To add (POST) test CAC use the following command:
+  ````
+  $ bundle exec exe/emasser post pac add --systemId [value] --controlAcronym [value] --comments [value]
+  ````
+  - required parameter are:
+    |parameter          | type or values                                              |
+    |-------------------|:------------------------------------------------------------|
+    |--systemId         |Integer - Unique system identifier                           |
+    |--controlAcronym   |String - Control acronym associated with the POA&M Item. NIST SP 800-53 Revision 4 defined |
+  - conditional parameter is:
+    |parameter          | type or values                             |
+    |-------------------|:-------------------------------------------|
+    |--comments         |String -The control approval chain comments |
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser post cac help add
+```
+[top](#post)
+### ``post pac``
+----
+Submit control to second role of CAC
+To add (POST) test PAC use the following command:
+  ````
+  $ bundle exec exe/emasser post pac add --systemId [value] --workflow [value] --name [value] --comments [value]
+  ````
+  - required parameter are:
+    |parameter     | type or values                                                            |
+    |--------------|:--------------------------------------------------------------------------|
+    |--systemId    |Integer - Unique system identifier                                         |
+    |--workflow    |Possible Values: Assess and Authorize, Assess Only, Security Plan Approval |
+    |--name        |String - Package name. 100 Characters                                      |
+    |--comments    |String - Comments submitted upon initiation of the indicated workflow, 4,000 character|
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser post pac help add
+```
+[top](#post)
+### ``post static_code_scan``
+----
+To add (POST) static code scans use the following command:
+  ````
+  $ bundle exec exe/emasser post scan_findings add --systemId [value] --applicationName [value] --version [value] --codeCheckName [value] --scanDate [value] --cweId [value]
+  ````
+  - required parameter are:
+    |parameter          | type or values                                             |
+    |-------------------|:-----------------------------------------------------------|
+    |--systemId         |Integer - Unique system identifier                          |
+    |--applicationName  |String - Name of the software application that was assessed |
+    |--version          |String - The version of the application                     |
+    |--codeCheckName    |Strings - Name of the software vulnerability or weakness    |
+    |--scanDate         |Date - The findings scan date - Unix time format            |
+    |--cweId            |String - The Common Weakness Enumerator (CWE) identifier    |
+  - optional parameters are:
+    |parameter          | type or values                                        |
+    |-------------------|:------------------------------------------------------|
+    |--rawSeverity*     |Possible Values: Low, Medium, Moderate, High, Critical |
+    |--count            |Integer - Number of instances observed for a specified |
+*rawSeverity: In eMASS, values of "Critical" will appear as "Very High", and values of "Medium" will appear as "Moderate". Any values not listed as options in the list above will map to "Unknown" and appear as blank values.
+To clear (POST) static code scans use the following command:
+  ````
+  $ bundle exec exe/emasser post scan_findings clear --systemId [value] --applicationName [value] --version [value] --clearFindings
+  ````
+  - required parameter are:
+    |parameter          | type or values                                             |
+    |-------------------|:-----------------------------------------------------------|
+    |--systemId         |Integer - Unique system identifier                          |
+    |--applicationName  |String - Name of the software application that was assessed |
+    |--clearFindings*   |Boolean - To clear an application's findings set it to true |
+*The clearFindings field is an optional field, but required with a value of "True" to clear out all application findings for a single application/version pairing.
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser post scan_findings help add
+```
+[top](#post)
+### ```post cloud_resource```
+---
+The following Cloud Resource parameters/fields have the following character limitations:
+- Fields that can not exceed 50 characters:
+  - Policy Deployment Version (`policyDeploymentVersion`)
+- Fields that can not exceed 100 characters:
+  - Assessment Procedure      (`assessmentProcedure`)
+  - Security Control Acronym  (`control`)
+  - CSP Account ID            (`cspAccountId`)
+  - CSP Region                (`cspRegion`)
+  - Email of POC              (`initiatedBy`)
+  - Cloud Service Provider    (`provider`)
+  - Type of Cloud resource    (`resourceType`)
+- Fields that can not exceed 500 characters:
+  - CSP/Resource’s Policy ID  (`cspPolicyDefinitionId`)
+  - Policy Deployment Name    (`policyDeploymentName`)
+  - Policy Compliance ID      (`resourceId`)
+  - Cloud Resource Name       (`resourceName`)
+- Fields that can not exceed 1000 characters:
+  - Reason for Compliance (`complianceReason`)
+- Fields that can not exceed 2000 characters:
+  - Policy Short Title    (`policyDefinitionTitle`)
+To add a cloud resource and their scan results in the assets module for a system use the following command:
+````
+  $ bundle exec exe/emasser post cloud_resource add --systemId [value] --provider [value] --resourceId [value] --resourceName [value] --resourceType [value] --cspPolicyDefinitionId [value] --isCompliant or --is-not-Compliant --policyDefinitionTitle [value] --test [value]
+````
+  - required parameter are:
+    |parameter               | type or values                                                            |
+    |------------------------|:--------------------------------------------------------------------------|
+    |--systemId              |Integer - Unique system identifier                                         |
+    |--provider              |string - Cloud service provider name                                       |
+    |--resourceId            |String - Unique identifier/resource namespace for policy compliance result |
+    |--resourceName          |String - Friendly name of Cloud resource                                   |
+    |--resourceType          |String - Type of Cloud resource                                            |
+    |--cspPolicyDefinitionId |String - Unique identifier/compliance namespace for CSP/Resource\'s policy definition/compliance check|
+    |--isCompliant | Boolean - Compliance status of the policy for the identified cloud resource         |
+    |--policyDefinitionTitle | String - Friendly policy/compliance check title. Recommend short title    |
+  - optional parameters are:
+    |parameter          | type or values                                        |
+    |-------------------|:------------------------------------------------------|
+    |--initiatedBy      |String - Person initiating the process email address |
+    |--cspAccountId     |String - System/owner\'s CSP account ID/number |
+    |--cspRegion        |String - CSP region of system |
+    |--isBaseline       |Boolean - Flag that indicates in results is a baseline |
+    |Tags Object (tags)|
+    |--text | String - Text that specifies the tag type |
+    |Compliance Results Array Objects (complianceResults)|
+    |--assessmentProcedure      |String - Comma separated correlation to Assessment Procedure (i.e. CCI number for DoD Control Set) |
+    |--complianceCheckTimestamp |Date - The compliance check date - Unix time format |
+    |--complianceReason         |String - Reason/comments for compliance result |
+    |--control                  |String - Comma separated correlation to Security Control (e.g. exact NIST Control acronym) |
+    |--policyDeploymentName     |String - Name of policy deployment |
+    |--policyDeploymentVersion  |String - Version of policy deployment |
+    |--severity                 |Possible Values: Low, Medium, High, Critical |
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser post cloud_resource help add
+```
+[top](#post)
+### ```post container```
+---
+The following Container parameters/fields have the following character limitations:
+- Fields that can not exceed 100 characters:
+  - STIG Benchmark ID      (`benchmark`)
+  - Container Namespace    (`namespace`)
+  - Kubernetes assigned IP (`podIp`)
+  - Kubernetes Pod Name)   (`podName`)
+- Fields that can not exceed 500 characters:
+  - Container ID              (`containerId`)
+  - Friendly Container Name    (`containerName`)
+- Fields that can not exceed 1000 characters:
+  - Result Comments (`message`)
+To add containers and their scan results in the assets module for a system use the following command:
+````
+  $ bundle exec ruby exe/emasser post container add --systemId [value] --containerId [value] --containerName [value] --time [value] --benchmark [value] --lastSeen [value] --ruleId [value] --status [value]
+````
+  - required parameter are:
+    |parameter               | type or values                                                            |
+    |------------------------|:--------------------------------------------------------------------------|
+    |--systemId              |Integer - Unique system identifier                                         |
+    |--containerId           |String - Unique identifier of the container  |
+    |--containerName         |String - Friendly name of the container      |
+    |--time                  |Date   - Datetime of scan/result. Unix date format |
+    |Bench Marks Object (benchmarks)|
+    |--benchmark         |String - Identifier of the benchmark/grouping of compliance results  |
+    |benchmarks.results  |Object
+    |--ruleId            |String - Identifier for the compliance result, vulnerability, etc.
+    |--status            |String - Benchmark result status
+    |--lastSeen          |Date - Date last seen, Unix date format
+  - optional parameters are:
+    |parameter                   | type or values                                        |
+    |----------------------------|:------------------------------------------------------|
+    |--podName          |String - Name of pod (e.g. Kubernetes pod) |
+    |--podIp            |String - IP address of pod  |
+    |--namespace        |String - Namespace of container in container orchestration (e.g. Kubernetes namespace)|
+    |Tags Object (tags)|
+    |--text | String - Text that specifies the tag type |
+    |Bench Marks Object (benchmarks)
+    |--isBaseline       |Boolean - True/false flag for providing results as baseline. If true, all existing compliance results for the provided benchmark within the container will be replaced by results in the current call|
+    |benchmarks.results  |Object
+    |--message           |String - Comments for the result
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser post container help add
+```
+[top](#post)
+## Usage - PUT
+### ``put controls``
+----
+Business Rules
+The following fields are required based on the value of the `implementationStatus` field
+  |Value                   |Required Fields
+  |------------------------|--------------------------------------------------------
+  |Planned or Implemented  |controlDesignation, estimatedCompletionDate, responsibleEntities, slcmCriticality, slcmFrequency, slcmMethod, slcmMethod, slcmTracking, slcmComments
+  |Not Applicable          |naJustification, controlDesignation, responsibleEntities
+  |Manually Inherited      |controlDesignation, estimatedCompletionDate, responsibleEntities, slcmCriticality, slcmFrequency, slcmMethod, slcmMethod, slcmTracking, slcmComments
+Implementation Plan cannot be updated if a Security Control is "Inherited" except for the following fields:
+  - Common Control Provider (commonControlProvider)
+  - Security Control Designation (controlDesignation)
+The following parameters/fields have the following character limitations:
+- Implementation Plan information cannot be saved if the fields below exceed 2,000 character limits:
+  - N/A Justification        (`naJustification`)
+  - Responsible Entities     (`responsibleEntities`)
+  - Implementation Narrative (`implementationNarrative`)
+  - Criticality              (`slcmCriticality`)
+  - Reporting                (`slcmReporting`)
+  - Tracking                 (`slcmTracking`)
+  - Vulnerability Summary    (`vulnerabilitySummary`)
+  - Recommendations          (`recommendations`)
+- Implementation Plan information cannot be saved if the fields below exceed 4,000 character limits:
+  - SLCM Comments            (`slcmComments`)
+Implementation Plan information cannot be updated if Security Control does not exist in the system record.
+---
+Updating (PUT) a Control can be accomplished by invoking the following command:
+  ````
+  $ bundle exec exe/emasser put controls update [PARAMETERS]
+  ````
+  - required parameter are:
+    |parameter                 | type or values                                                           |
+    |--------------------------|:-------------------------------------------------------------------------|
+    |--systemId                |Integer - Unique system identifier                                        |
+    |--acronym                 |String - The system acronym(s) e.g "AC-1, AC-2"                           |
+    |--responsibleEntities     |String - Description of the responsible entities for the Security Control |
+    |--controlDesignation      |Possible values: Common, System-Specific, or Hybrid                       |
+    |--estimatedCompletionDate |Date - Unix time format (e.g. 1499990400)                                 |
+    |--comments                |String - Security control comments                                        |
+  - optional parameters are:
+    |parameter              | type or values                                |
+    |-----------------------|:----------------------------------------------|
+    |--implementationStatus |Possible values: Planned, Implemented, Inherited, Not Applicable, or Manually Inherited|
+    |--severity             |Possible values: Very Low, Low, Moderate, High, Very High |
+    |--vulnerabiltySummary  |String - The security control vulnerability summary |
+    |--recommendations      |String - The security control vulnerability recommendation |
+    |--relevanceOfThreat    |Possible values: Very Low, Low, Moderate, High, Very High |
+    |--likelihood           |Possible values: Very Low, Low, Moderate, High, Very High |
+    |--impact               |Possible values: Very Low, Low, Moderate, High, Very High |
+    |--impactDescription    |String, - Description of the security control impact |
+    |--residualRiskLevel    |Possible values: Very Low, Low, Moderate, High, Very High |
+  - conditional parameters are:
+    |parameter               | type or values                                |
+    |------------------------|:----------------------------------------------|
+    |--commonControlProvider |Possible values: DoD, Component, Enclave|
+    |--naJustification       |String - Justification for Security Controls deemed Not Applicable to the system |
+    |--slcmCriticality       |String - Criticality of Security Control regarding SLCM |
+    |--slcmFrequency         |Possible values - Constantly, Daily, Weekly, Monthly, Quarterly, Semi-Annually, Annually, or Undetermined |
+    |--slcmMethod            |Possible values: Automated, Semi-Automated, Manual, or Undetermined |
+    |--slcmReporting         |String - The System-Level Continuous Monitoring reporting |
+    |--slcmTracking          |String - The System-Level Continuous Monitoring tracking |
+    |--slcmComments          |String, - Additional comments for Security Control regarding SLCM |
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser put controls help update
+```
+[top](#put)
+### ``put poams``
+----
+Business Rules
+The following fields are required based on the value of the `status` field
+  |Value           |Required Fields
+  |----------------|--------------------------------------------------------
+  |Risk Accepted   |comments, resources
+  |Ongoing         |scheduledCompletionDate, resources, milestones (at least 1)
+  |Completed       |scheduledCompletionDate, comments, resources,
+  |                |completionDate, milestones (at least 1)
+  |Not Applicable  |POAM can not be created
+If a POC email is supplied, the application will attempt to locate a user already registered within the application and pre-populate any information not explicitly supplied in the request. If no such user is found, these fields are required within the request.
+  - pocOrganization, pocFirstName, pocLastName, pocEmail, pocPhoneNumber
+Business logic, the following rules apply when adding POA&Ms
+- POA&M Item cannot be saved if associated Security Control or AP is inherited.
+- POA&M Item cannot be created manually if a Security Control or AP is Not Applicable.
+- Completed POA&M Item cannot be saved if Completion Date is in the future.
+- Completed POA&M Item cannot be saved if Completion Date (completionDate) is in the future.
+- Risk Accepted POA&M Item cannot be saved with a Scheduled Completion Date (scheduledCompletionDate) or Milestones
+- POA&M Item with a review status of "Not Approved" cannot be saved if Milestone Scheduled Completion Date exceeds POA&M Item  Scheduled Completion Date.
+- POA&M Item with a review status of "Approved" can be saved if Milestone Scheduled Completion Date exceeds POA&M Item Scheduled Completion Date.
+- POA&M Items that have a status of "Completed" and a status of "Ongoing" cannot be saved without Milestones.
+- POA&M Items that have a status of "Risk Accepted" cannot have milestones.
+- POA&M Items with a review status of "Approved" that have a status of "Completed" and "Ongoing" cannot update Scheduled Completion Date.
+- POA&M Items that have a review status of "Approved" are required to have a Severity Value assigned.
+- POA&M Items cannot be updated if they are included in an active package.
+- Archived POA&M Items cannot be updated.
+- POA&M Items with a status of "Not Applicable" will be updated through test result creation.
+- If the Security Control or Assessment Procedure does not exist in the system we may have to just import POA&M Item at the System Level.
+The following parameters/fields have the following character limitations:
+- POA&M Item cannot be saved if the Point of Contact fields exceed 100 characters:
+  - Office / Organization (pocOrganization)
+  - First Name            (pocFirstName)
+  - Last Name             (pocLastName)
+  - Email                 (email)
+  - Phone Number          (pocPhoneNumber)
+- POA&M Item cannot be saved if Mitigation field (mitigation) exceeds 2,000 characters.
+- POA&M Item cannot be saved if Source Identifying Vulnerability field (sourceIdentVuln) exceeds 2,000 characters.
+- POA&M Item cannot be saved if Comments field (comments) exceeds 2,000 characters
+- POA&M Item cannot be saved if Resource field (resource) exceeds 250 characters.
+- POA&M Items cannot be saved if Milestone Description (description) exceeds 2,000 characters.
+The following POA&M parameters/fields have the following character limitations:
+- Fields that can not exceed 100 characters:
+  - Office / Organization (`pocOrganization`)
+  - First Name            (`pocFirstName`)
+  - Last Name             (`pocLastName`)
+  - Email                 (`email`)
+  - Phone Number          (`pocPhoneNumber`)
+  - External Unique ID    (`externalUid`)
+- Fields that can not exceed 250 characters:
+  - Resource              (`resource`)
+- Fields have can not exceed 2000 character:
+  - Vulnerability Description        (`vulnerabilityDescription`)
+  - Source Identifying Vulnerability (`sourceIdentVuln`)
+  - Recommendations                  (`recommendations`)
+  - Risk Accepted Comments           (`comments`)
+  - Milestone Description            (`description`)
+  - Mitigation Justification         (`mitigation`)
+---
+Updating (PUT) a POA&M can be accomplished by invoking the following command:
+  ````
+  $ bundle exec exe/emasser put poams update [PARAMETERS]
+  ````
+  - required parameter are:
+    |parameter                  | type or values                                                 |
+    |---------------------------|:---------------------------------------------------------------|
+    |--systemId                 |Integer - Unique system identifier                              |
+    |--displayPoamId            |Integer - Globally unique identifier for individual POA&M Items |
+    |--status                   |Possible Values: Ongoing,Risk Accepted,Completed,Not Applicable |
+    |--vulnerabilityDescription |String - Vulnerability description for the POA&M Item           |
+    |--sourceIdentVuln          |String - Include Source Identifying Vulnerability text          |
+    |--pocOrganization          |String - Organization/Office represented                        |
+    |--resources                |String - List of resources used. Character Limit = 250          |
+    ** If any poc information is provided all POC fields are required. See additional details for POC fields below.
+  - conditional parameters are:
+    |parameter                 | type or values                                                         |
+    |--------------------------|:-----------------------------------------------------------------------|
+    |--milestones              |JSON -  see milestone format                                            |
+    |--pocFirstName            |String - First name of POC                                              |
+    |--pocLastName             |String - Last name of POC                                               |
+    |--pocEmail                |String - Email address of POC                                           |
+    |--pocPhoneNumber          |String - Phone number of POC (area code) ***-**** format                |
+    |--severity                |Possible values - Very Low, Low, Moderate, High, Very High              |
+    |--scheduledCompletionDate |Date - Required for ongoing and completed POA&M items. Unix time format |
+    |--completionDate          |Date - Field is required for completed POA&M items. Unix time format    |
+    |--comments                |String - Field is required for completed and risk accepted POA&M items  |
+    |--isActive                |Boolean - Used to delete milestones when updating a POA&M               |
+    ** If a POC email is supplied, the application will attempt to locate a user already registered within the application and pre-populate any information not explicitly supplied in the request. If no such user is found, these fields are required within the request:
+      pocFirstName, pocLastName, pocPhoneNumber
+    Milestone Format:
+      - --milestone milestoneId:[value] description:[value] scheduledCompletionDate:[value]
+      - If a milestoneId is not provide a new milestone is created
+  - optional parameters are:
+    |parameter           | type or values                                                                           |
+    |--------------------|:-----------------------------------------------------------------------------------------|
+    |--externalUid       |String - External unique identifier for use with associating POA&M Items                  |
+    |--controlAcronym    |String - Control acronym associated with the POA&M Item. NIST SP 800-53 Revision 4 defined|
+    |--cci               |String - CCI associated with the test result                                              |
+    |--securityChecks    |String - Security Checks that are associated with the POA&M                               |
+    |--rawSeverity       |Possible values: I, II, III                                                               |
+    |--relevanceOfThreat |Possible values: Very Low, Low, Moderate, High, Very High                                 |
+    |--likelihood        |Possible values: Very Low, Low, Moderate, High, Very High                                 |
+    |--impact            |Possible values: Very Low, Low, Moderate, High, Very High                                 |
+    |--impactDescription |String - Include description of Security Control’s impact                                 |
+    |--residualRiskLevel |Possible values: Very Low, Low, Moderate, High, Very High                                 |
+    |--recommendations   |String - Include recommendations                                                          |
+    |--mitigation        |String - Include mitigation explanation. 2000 Characters                                  |
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser put poams help update
+```
+[top](#put)
+### ``put milestones``
+----
+To add (POST) milestones in a system for one or more POA&M items use the following command:
+````
+  $ bundle exec exe/emasser put milestones update [PARAMETERS]
+````
+  - required parameter are:
+    |parameter                  | type or values                                      |
+    |---------------------------|:----------------------------------------------------|
+    |--systemId                 |Integer - Unique system identifier                   |
+    |--poamId                   |Integer - Unique poam identifier                     |
+    |--milestoneId              |Integer - Unique milestone identifier                |
+    |--description              |String - Milestone item description. 2000 Characters |
+    |--scheduledCompletionDate  |Date - Schedule completion date. Unix date format    |
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser put milestones help update
+```
+[top](#put)
+### ``put artifacts``
+----
+Business Rules
+- Artifact cannot be saved if the file does not have the following file extensions:
+  - .docx,.doc,.txt,.rtf,.xfdl,.xml,.mht,.mhtml,.html,.htm,.pdf
+  - .mdb,.accdb,.ppt,.pptx,.xls,.xlsx,.csv,.log
+  - .jpeg,.jpg,.tiff,.bmp,.tif,.png,.gif
+  - .zip,.rar,.msg,.vsd,.vsw,.vdx, .z{#}, .ckl,.avi,.vsdx
+- Artifact cannot be saved if File Name (fileName) exceeds 1,000 characters
+- Artifact cannot be saved if Description (description) exceeds 2,000 characters
+- Artifact cannot be saved if Reference Page Number (refPageNumber) exceeds 50 characters
+- Artifact cannot be saved if the file does not have an allowable file extension/type.
+- Artifact version cannot be saved if an Artifact with the same file name already exist in the system.
+- Artifact cannot be saved if the file size exceeds 30MB.
+- Artifact cannot be saved if the Last Review Date is set in the future.
+To add (POST) milestones in a system for one or more POA&M items use the following command:
+````
+  $ bundle exec exe/emasser put artifacts update [PARAMETERS]
+````
+  - required parameter are:
+    |parameter       | type or values                                      |
+    |----------------|:----------------------------------------------------|
+    |--systemId      |Integer - Unique system identifier                   |
+    |--filename        |String - File name should match exactly one file within the provided zip file|
+    |                |Binary  - Application/zip file. Max 30MB per artifact |
+    |--isTemplate    |Boolean - Indicates whether an artifact is a template|
+    |--type*         |Possible Values: Procedure, Diagram, Policy, Labor, Document, Image, Other, Scan Result, Auditor Report|
+    |--category*     |Possible Values: Implementation Guidance, Evidence    |
+    *May also accept custom artifact category values set by system administrators.
+  - optional parameter are:
+    |parameter                | type or values                                        |
+    |-------------------------|:------------------------------------------------------|
+    |--description            |String - Artifact description. 2000 Characters         |
+    |--refPageNumber          |String - Artifact reference page number. 50 Characters |
+    |--ccis                   |String -  CCIs associated with artifact                |
+    |--controls               |String - Control acronym associated with the artifact. NIST SP 800-53 Revision 4 defined|
+    |--artifactExpirationDate |Date - Date Artifact expires and requires review. In Unix Date Format|
+    |--lastReviewedDate       |Date - Date Artifact was last reviewed. In Unix Date Format          |
+**Note**
+For information at the command line use:
+```
+$ bundle exec exe/emasser put artifacts help update
+```
+[top](#put)
+## Usage - DELETE
+### ``delete poams``
+----
+Remove one or many poa&m items in a system
+To remove (DELETE) one or more POA&M items use the following command:
+```
+bundle exec exe/emasser delete poams remove --systemId [value] --poamId [value]
+```
+[top](#delete)
+### ``delete milestones``
+----
+Remove milestones in a system for one or many POA&M items
+To delete a milestone the record must be inactive by having the field isActive set to false (isActive=false).
+The server returns an empty object upon successfully deleting a milestone.
+The last milestone can not be deleted, at-least on must exist.
+To remove (DELETE) one or more Milestones in a system use the following command:
+```
+bundle exec exe/emasser delete milestones remove--systemId [value] --poamId [value] --milestoneId [value]
+```
+[top](#delete)
+### ``delete artifacts``
+---
+Remove one or many artifacts in a system
+Provide single file or a space/comma delimited list of file names to be removed from the system (systemId)
+To remove (DELETE) one or more Artifacts from a system use the following command:
+```
+bundle exec exe/emasser delete artifacts remove --systemId [value] --files [value]
+or
+bundle exec exe/emasser delete artifacts remove --systemId [value] --files [value value...]
+or
+bundle exec exe/emasser delete artifacts remove --systemId [value] --files [value, value...]
+```
 [top](#delete)