Sign in
Orchestrator

List all assessment results. Part of the public API, also exposed as REST.

get/v1/orchestrator/assessment_results

Query parameters

filter.targetOfEvaluationIdstring

Optional. List only assessment results of a specific target of evaluation.

filter.compliantboolean

Optional. List only compliant assessment results.

filter.metricIdsstring[]

Optional. List only assessment results of a specific metric id.

filter.metricIdstring
filter.toolIdstring

Optional. List only assessment result from a specific assessment tool.

filter.assessmentResultIdsstring[]

Optional. List only assessment result from a specific list of IDs.

latestByResourceIdboolean

Optional. Latest results grouped by resource_id and metric_id.

pageSizeinteger
pageTokenstring
orderBystring
ascboolean

Response

OK

nextPageTokenstring

Changes

Changed in 11 of the 50 revisions of this API.172348

  • 36dbd5beec6213See the full diff
    • ▲

      removed the required property results/items/timestamp from the response with the 200 status

      response-required-property-removed

    • ○

      added the required property results/items/createdAt to the response with the 200 status

      response-required-property-added

    • ○

      added the required property results/items/history to the response with the 200 status

      response-required-property-added

    • ○

      added the required property results/items/historyUpdatedAt to the response with the 200 status

      response-required-property-added

  • f2db05790701213See the full diff
    • ▲

      removed the required property results/items/certificationTargetId from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property results/items/metricConfiguration/allOf[MetricConfiguration]/certificationTargetId from the response with the 200 status

      response-required-property-removed

    • ●

      deleted the query request parameter filter.certificationTargetId

      request-parameter-removed

    • ○

      added the new optional query request parameter filter.targetOfEvaluationId

      new-optional-request-parameter

    • ○

      added the required property results/items/metricConfiguration/allOf[MetricConfiguration]/targetOfEvaluationId to the response with the 200 status

      response-required-property-added

    • ○

      added the required property results/items/targetOfEvaluationId to the response with the 200 status

      response-required-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2b79660c20a0217See the full diff
    • ●

      removed the optional property results/items/nonComplianceComments from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property results/items/nonComplianceDetails from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter filter.assessmentResultIds

      new-optional-request-parameter

    • ○

      added the optional property results/items/complianceDetails to the response with the 200 status

      response-optional-property-added

    • ○

      the response property results/items/certificationTargetId became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/evidenceId became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/id became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/metricConfiguration became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/metricConfiguration/allOf[MetricConfiguration]/certificationTargetId became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/metricConfiguration/allOf[MetricConfiguration]/isDefault became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/metricConfiguration/allOf[MetricConfiguration]/metricId became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/metricConfiguration/allOf[MetricConfiguration]/operator became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/metricConfiguration/allOf[MetricConfiguration]/targetValue became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/metricId became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/resourceId became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/resourceTypes became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/timestamp became required for the status 200

      response-property-became-required

    • ○

      the response property results/items/toolId became required for the status 200

      response-property-became-required

    • ○

      added the required property results/items/complianceComment to the response with the 200 status

      response-required-property-added

  • 161557f4ca311See the full diff
    • ○

      added the optional property results/items/nonComplianceDetails to the response with the 200 status

      response-optional-property-added

  • 8e05a12e21d033See the full diff
    • ●

      deleted the query request parameter filter.cloudServiceId

      request-parameter-removed

    • ●

      removed the optional property results/items/cloudServiceId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property results/items/metricConfiguration/allOf[MetricConfiguration]/cloudServiceId from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter filter.certificationTargetId

      new-optional-request-parameter

    • ○

      added the optional property results/items/certificationTargetId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property results/items/metricConfiguration/allOf[MetricConfiguration]/certificationTargetId to the response with the 200 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b58167cced1e161See the full diff
    • ▲

      the results/items/metricConfiguration response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property results/items/metricConfiguration/cloudServiceId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property results/items/metricConfiguration/isDefault from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property results/items/metricConfiguration/metricId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property results/items/metricConfiguration/operator from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property results/items/metricConfiguration/targetValue from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property results/items/metricConfiguration/updatedAt from the response with the 200 status

      response-optional-property-removed

    • ○

      added MetricConfiguration to the results/items/metricConfiguration response property allOf list for the response status 200

      response-property-all-of-added

  • 61f295ad12bb2See the full diff
    • ○

      added the new optional query request parameter filter.toolId

      new-optional-request-parameter

    • ○

      added the optional property results/items/toolId to the response with the 200 status

      response-optional-property-added

  • 412a107aaeaa34See the full diff
    • ●

      deleted the query request parameter filteredCloudServiceId

      request-parameter-removed

    • ●

      deleted the query request parameter filteredCompliant

      request-parameter-removed

    • ●

      deleted the query request parameter filteredMetricId

      request-parameter-removed

    • ○

      added the new optional query request parameter filter.cloudServiceId

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter.compliant

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter.metricId

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter.metricIds

      new-optional-request-parameter

  • c362245d77111See the full diff
    • ○

      added the new optional query request parameter latestByResourceId

      new-optional-request-parameter

  • 683e68f555d32See the full diff
    • ○

      added the new optional query request parameter filteredCompliant

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filteredMetricId

      new-optional-request-parameter