Skip to content
English
  • There are no suggestions because the search field is empty.

Get evaluation result

GET /api/v2/evaluations/{id} Select code sample Fetch cURL
const url = 'https://localhost:10001/api/v2/evaluations/example';const options = {method: 'GET', headers: {Authorization: '
  
   '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}
  
curl --request GET \  --url https://localhost:10001/api/v2/evaluations/example \  --header 'Authorization: 
  
   '
  

Retrieve a single evaluation result by its UUID

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ” id required string

Evaluation Result UUID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Evaluation result

Media type application/json object applicationId integer createdAt string criterionResults Array object criteriaIndex integer field string reason string status stringAllowed values: pass fail skipped declarationIds Array durationMs integer evaluatedAt string extractedFields object failureDetails Array object actualValue arrayMatchMode stringAllowed values: all any criteriaIndex integer criteriaType stringAllowed values: string number boolean date list[string] list[number] elementPath string expectedValue extractionPath string field string indexPath Array missing boolean operator stringAllowed values: eq neq gt lt gte lte in notIn contains notContains reason string failureReasons Array id string indicatorId string payloadHash string payloadTruncated boolean result stringAllowed values: pass fail error awaiting_evaluation triggerSource string
Example
{  "criterionResults": [    {      "status": "pass"    }  ],  "failureDetails": [    {      "arrayMatchMode": "all",      "criteriaType": "string",      "operator": "eq"    }  ],  "result": "pass"}

400

Section titled “400 ”

Bad request - Invalid evaluation result ID format

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

401

Section titled “401 ”

Unauthorized - Authentication required

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

403

Section titled “403 ”

Forbidden - Insufficient permissions

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

404

Section titled “404 ”

Evaluation result not found

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

500

Section titled “500 ”

Internal server error

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}
Previous
List evaluation results
Next
Ingest event for indicator evaluation