Get evaluation result

GET

/api/v2/evaluations/{id}

curl --request GET \
  --url https://localhost:10001/api/v2/evaluations/example \
  --header 'Authorization: <Authorization>'

Retrieve a single evaluation result by its UUID

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Evaluation result UUID (urn:uuid optional)

Responses

200

Evaluation result

Media type application/json

One indicator evaluation, including its criteria outcomes and any declaration it produced

object

applicationId

integer

createdAt

string format: date-time

criterionResults

Array<object>

One criterion’s outcome within an evaluation; the evaluation passes only when every criterion does

object

criteriaIndex

integer

field

string

reason

string

status

string

Allowed values: pass fail skipped

declarationIds

Array<integer>

durationMs

Evaluation wall time in milliseconds

integer

evaluatedAt

string format: date-time

extractedFields

object

failureDetails

Array<object>

The machine-readable reason a criterion failed, including the values compared

object

actualValue

arrayMatchMode

string

Allowed values: all any

criteriaIndex

integer

criteriaType

string

Allowed values: string number boolean date list[string] list[number]

elementPath

string

expectedValue

extractionPath

string

field

string

indexPath

Array<integer>

missing

boolean

operator

string

Allowed values: eq neq gt lt gte lte in notIn contains notContains

reason

string

failureReasons

Array<string>

id

Urn:uuid form

string

indicatorId

Urn:uuid form

string

result

string

Allowed values: pass fail error awaiting_evaluation

triggerSource

string

Example

{
  "criterionResults": [
    {
      "status": "pass"
    }
  ],
  "failureDetails": [
    {
      "arrayMatchMode": "all",
      "criteriaType": "string",
      "operator": "eq"
    }
  ],
  "result": "pass"
}

400

Bad request - Invalid evaluation result ID format

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

401

Unauthorized - Authentication required

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

403

Forbidden - Insufficient permissions

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

404

Evaluation result not found

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

500

Internal server error

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}