Evaluation

POST /v1/evaluation/results

Changed on

Creates an evaluation result

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body

idstring required

Evaluation result id

targetOfEvaluationIdstring

The Target of Evaluation ID the evaluation belongs to

auditScopeIdstring

The Audit Scope ID the evaluation belongs to

controlIdstring

The control id the evaluation was based on

controlCategoryNamestring

The category the evaluated control belongs to

controlCatalogIdstring

The catalog the evaluated control belongs to

parentControlIdstring

Optionally, specifies the parent control ID, if this is a sub-control

status'EVALUATION_STATUS_UNSPECIFIED' | 'EVALUATION_STATUS_COMPLIANT' | 'EVALUATION_STATUS_COMPLIANT_MANUALLY' | 'EVALUATION_STATUS_NOT_COMPLIANT' | 'EVALUATION_STATUS_NOT_COMPLIANT_MANUALLY' | 'EVALUATION_STATUS_PENDING' enum required

Evaluation status

timestampstring date-time required

Time of evaluation

assessmentResultIdsstring[] required

List of assessment results because of which the evaluation status is compliant or not compliant

commentstring
validUntilstring date-time

Optional, but required if the status is one of the "manually" ones. This denotes how long the (manual) created evaluation result is valid. During this time, no automatic results are generated for the specific control.

Response

OK

idstring required

Evaluation result id

targetOfEvaluationIdstring

The Target of Evaluation ID the evaluation belongs to

auditScopeIdstring

The Audit Scope ID the evaluation belongs to

controlIdstring

The control id the evaluation was based on

controlCategoryNamestring

The category the evaluated control belongs to

controlCatalogIdstring

The catalog the evaluated control belongs to

parentControlIdstring

Optionally, specifies the parent control ID, if this is a sub-control

status'EVALUATION_STATUS_UNSPECIFIED' | 'EVALUATION_STATUS_COMPLIANT' | 'EVALUATION_STATUS_COMPLIANT_MANUALLY' | 'EVALUATION_STATUS_NOT_COMPLIANT' | 'EVALUATION_STATUS_NOT_COMPLIANT_MANUALLY' | 'EVALUATION_STATUS_PENDING' enum required

Evaluation status

timestampstring date-time required

Time of evaluation

assessmentResultIdsstring[] required

List of assessment results because of which the evaluation status is compliant or not compliant

commentstring
validUntilstring date-time

Optional, but required if the status is one of the "manually" ones. This denotes how long the (manual) created evaluation result is valid. During this time, no automatic results are generated for the specific control.

Changes

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • breaking

      added the new required request property

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status