v1

latestOpenAPI 3.0.32026-07-174611.8 KB
Evaluation

Creates an evaluation result

post/v1/evaluation/results

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.