POST /v1/orchestrator/assessment_results — orchestrator-api

Orchestrator

Stores the assessment result provided by an assessment tool

post/v1/orchestrator/assessment_results

Request body

idstring required

Assessment result id

createdAtstring date-time required

Time of assessment

metricIdstring required

Reference to the metric the assessment was based on

compliantboolean

Compliant case: true or false

evidenceIdstring required

Reference to the last assessed evidence

resourceIdstring required

Reference to the resource of the assessed evidence

resourceTypesstring[] required

Resource types

complianceCommentstring required

ComplianceComment contains a human readable description on the reason for (non)-compliance.

targetOfEvaluationIdstring required

The target of evaluation which this assessment result belongs to

toolIdstring required

Reference to the tool which provided the assessment result

historyUpdatedAtstring date-time required

The time of the last update of the assessment result history field

Response

StoreAssessmentResultResponse required

StoreAssessmentResultReponse belongs to StoreAssessmentResult, which uses a custom unary RPC and therefore requires a response message according to the style convention. Since no return values are required, this is empty.

Changes

Changed in 9 of the 50 revisions of this API.232322

Jul 16, 202536dbd5beec6231See the full diff
- ▲
  added the new required request property createdAt
  new-required-request-property
- ▲
  added the new required request property history
  new-required-request-property
- ▲
  added the new required request property historyUpdatedAt
  new-required-request-property
- ●
  removed the request property timestamp
  request-property-removed
Mar 27, 2025f2db0579070122See the full diff
- ▲
  added the new required request property metricConfiguration/allOf[MetricConfiguration]/targetOfEvaluationId
  new-required-request-property
- ▲
  added the new required request property targetOfEvaluationId
  new-required-request-property
- ●
  removed the request property certificationTargetId
  request-property-removed
- ●
  removed the request property metricConfiguration/allOf[MetricConfiguration]/certificationTargetId
  request-property-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 8, 20252b79660c20a01521See the full diff
- ▲
  added the new required request property complianceComment
  new-required-request-property
- ▲
  the request property certificationTargetId became required
  request-property-became-required
- ▲
  the request property evidenceId became required
  request-property-became-required
- ▲
  the request property id became required
  request-property-became-required
- ▲
  the request property metricConfiguration became required
  request-property-became-required
- ▲
  the request property metricConfiguration/allOf[MetricConfiguration]/certificationTargetId became required
  request-property-became-required
- ▲
  the request property metricConfiguration/allOf[MetricConfiguration]/isDefault became required
  request-property-became-required
- ▲
  the request property metricConfiguration/allOf[MetricConfiguration]/metricId became required
  request-property-became-required
- ▲
  the request property metricConfiguration/allOf[MetricConfiguration]/operator became required
  request-property-became-required
- ▲
  the request property metricConfiguration/allOf[MetricConfiguration]/targetValue became required
  request-property-became-required
- ▲
  the request property metricId became required
  request-property-became-required
- ▲
  the request property resourceId became required
  request-property-became-required
- ▲
  the request property resourceTypes became required
  request-property-became-required
- ▲
  the request property timestamp became required
  request-property-became-required
- ▲
  the request property toolId became required
  request-property-became-required
- ●
  removed the request property nonComplianceComments
  request-property-removed
- ●
  removed the request property nonComplianceDetails
  request-property-removed
- ○
  added the new optional request property complianceDetails
  new-optional-request-property
Oct 16, 2024161557f4ca311See the full diff
- ○
  added the new optional request property nonComplianceDetails
  new-optional-request-property
Oct 1, 20248e05a12e21d022See the full diff
- ●
  removed the request property cloudServiceId
  request-property-removed
- ●
  removed the request property metricConfiguration/allOf[MetricConfiguration]/cloudServiceId
  request-property-removed
- ○
  added the new optional request property certificationTargetId
  new-optional-request-property
- ○
  added the new optional request property metricConfiguration/allOf[MetricConfiguration]/certificationTargetId
  new-optional-request-property
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 16, 2024b58167cced1e26See the full diff
- ▲
  added MetricConfiguration to the metricConfiguration request property allOf list
  request-property-all-of-added
- ▲
  the metricConfiguration request property type/format changed from object/ to /
  request-property-type-changed
- ●
  removed the request property metricConfiguration/cloudServiceId
  request-property-removed
- ●
  removed the request property metricConfiguration/isDefault
  request-property-removed
- ●
  removed the request property metricConfiguration/metricId
  request-property-removed
- ●
  removed the request property metricConfiguration/operator
  request-property-removed
- ●
  removed the request property metricConfiguration/targetValue
  request-property-removed
- ●
  removed the request property metricConfiguration/updatedAt
  request-property-removed
Jun 6, 202361f295ad12bb1See the full diff
- ○
  added the new optional request property toolId
  new-optional-request-property
Jan 30, 202362c28b7e64392See the full diff
- ●
  removed the optional property status from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property statusMessage from the response with the 200 status
  response-optional-property-removed
Nov 7, 20229aea46cc4c8a1817See the full diff
- ▲
  the metricConfiguration request property type/format changed from / to object/
  request-property-type-changed
- ●
  removed MetricConfiguration from the metricConfiguration request property allOf list
  request-property-all-of-removed
- ●
  removed the request property complianceComment
  request-property-removed
- ●
  removed the request property complianceDetails
  request-property-removed
- ●
  removed the request property createdAt
  request-property-removed
- ●
  removed the request property history
  request-property-removed
- ●
  removed the request property historyUpdatedAt
  request-property-removed
- ●
  removed the request property targetOfEvaluationId
  request-property-removed
- ●
  removed the request property toolId
  request-property-removed
- ○
  added the new optional request property cloudServiceId
  new-optional-request-property
- ○
  added the new optional request property metricConfiguration/cloudServiceId
  new-optional-request-property
- ○
  added the new optional request property metricConfiguration/isDefault
  new-optional-request-property
- ○
  added the new optional request property metricConfiguration/metricId
  new-optional-request-property
- ○
  added the new optional request property metricConfiguration/operator
  new-optional-request-property
- ○
  added the new optional request property metricConfiguration/targetValue
  new-optional-request-property
- ○
  added the new optional request property metricConfiguration/updatedAt
  new-optional-request-property
- ○
  added the new optional request property nonComplianceComments
  new-optional-request-property
- ○
  added the new optional request property timestamp
  new-optional-request-property
- ○
  the request property evidenceId became optional
  request-property-became-optional
- ○
  the request property id became optional
  request-property-became-optional
- ○
  the request property metricConfiguration became optional
  request-property-became-optional
- ○
  the request property metricId became optional
  request-property-became-optional
- ○
  the request property resourceId became optional
  request-property-became-optional
- ○
  the request property resourceTypes became optional
  request-property-became-optional
- ○
  added the optional property status to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property statusMessage to the response with the 200 status
  response-optional-property-added
This revision also has 110 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history